fluxer_dart 1.0.1
fluxer_dart: ^1.0.1 copied to clipboard
Dart SDK for Fluxer a free and open source instant messaging and VoIP platform.
Note
Learn about the developer behind Fluxer, the goals of the project, the tech stack, and what's coming next.
[Fluxer graphic logo]
Fluxer Dart SDK #
Fluxer is a free and open source instant messaging and VoIP platform for friends, groups, and communities. Self-host it and every feature is unlocked. This is a package for Dart / Flutter that allows you access to the Fluxer API, and it's also used in the offical Fluxer app!
Note
Improved README with more real examples coming soon.
Requirements #
- Dart 2.15.0+ or Flutter 2.8.0+
- Dio 5.0.0+ (https://pub.dev/packages/dio)
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
fluxer_dart: 1.0.0
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
fluxer_dart:
git:
url: https://github.com/fluxerapp/dart_sdk.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
fluxer_dart:
path: /path/to/fluxer_dart
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:fluxer_dart/fluxer_dart.dart';
final api = FluxerDart().getAdminApi();
final BanEmailRequest banEmailRequest = ; // BanEmailRequest |
try {
api.addEmailBan(banEmailRequest);
} catch on DioException (e) {
print("Exception when calling AdminApi->addEmailBan: $e\n");
}
Documentation For Authorization #
Authentication schemes defined for the API:
botToken #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
oauth2Token #
- Type: OAuth
- Flow: accessCode
- Authorization URL: /oauth2/authorize
- Scopes:
- identify: Read basic user identity information.
- email: Read the user email address.
- guilds: Read guild membership information for the current user.
- connections: Read linked third-party account connections for the current user.
- bot: Add a bot user to a guild.
- admin: Access admin endpoints when the user has admin ACLs.
bearerToken #
- Type: HTTP Bearer Token authentication
sessionToken #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
adminApiKey #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Package Gen #
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen