flyreel_sdk_flutter

Description:

flyreel sdk flutter

Flyreel Flutter SDK #




Requirements: #
Android #

Android 6+ (minSdk 23)
compileSdkVersion 34

iOS #

iOS 13+

Installation #
With flutter #
$ flutter pub add flyreel_sdk_flutter
copied to clipboard
Path dependency #
via ssh:
flyreel_sdk_flutter:
git:
url: [email protected]:Flyreel/flyreel-sdk-flutter.git
copied to clipboard
or
via https:
flyreel_sdk_flutter:
git:
url: https://github.com/Flyreel/flyreel-sdk-flutter.git
copied to clipboard
Usage #
Permissions on iOS #
Since the SDK actively uses some functionalities of the iOS system you need to provide a few
permission settings in your Info.plist file.

<dict>
// ...
<key>NSCameraUsageDescription</key>
<string>We need access to the camera.</string>
<key>NSMicrophoneUsageDescription</key>
<string>We need access to the camera.</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>We need access to your location data</string>
</dict>
copied to clipboard
Initialization #
To use the Flyreel SDK, you must provide a configuration with the following parameters:
settingsVersion: Identifier of your remote SDK settings.
organizationId: Identifier of your organization.
In your lib/main.dart file, initialize Flyreel using provided object:
void main() async {
WidgetsFlutterBinding.ensureInitialized();

// initialize Flyreel with organizationId and settingsVersion
var config = FlyreelConfig(
organizationId: "5d3633f9103a930011996475",
settingsVersion: 1,
);
await Flyreel.initialize(config);

runApp(const MyApp());
}
copied to clipboard
How to open Flyreel chat #
Invoke openFlyreel()
void openFlyreel() async {
await Flyreel.open();
}
copied to clipboard
Deep Linking #
If you're launching the Flyreel flow from a deep link, push notification, or a custom solution where
user details can be provided automatically, use:
void openFlyreelWithCredentials() async {
await Flyreel.openWithCredentials(
zipCode: "80212",
accessCode: "6M4T0T",
);
}

void openFlyreelWithUrl() async {
await Flyreel.open(
deeplinkUrl: "https://your.custom.url/?flyreelAccessCode=6M4T0T&flyreelZipCode=80212");
}
copied to clipboard
Custom fonts #
If you want to use a custom font for Flyreel chat, you have to provide a ttf file to both iOS and
Android Platform.

in the Android directory, you can put the ttf file in the main/assets folder or the main/res/font
folder.
for iOS, you have to go with
the Apple instruction
to add a custom font to your project.

Then, you can use the font's name in the Flyreel dashboard panel. For example, if you have added
font my_font.ttf to the assets folder, you can use my_font as a font name in the Flyreel
dashboard.
Debug Logs #
Enable debug logging for troubleshooting purposes:
void showLogs() async {
await Flyreel.enableLogs();
}
copied to clipboard
Check Flyreel status for given access and zip code #
You can manually check Flyreel status. This function makes a network request to retrieve the status
of Flyreel for the specified zip code and access code.
void checkFlyreelStatus() async {
try {
final result = await Flyreel.checkStatus(
zipCode: "80212",
accessCode: "6M4T0T",
);
print("Status: ${result.status}, expires: ${result.expiration}");
} on PlatformException catch (e) {
print("code: ${e.code}, message: ${e.message}");
}
}
copied to clipboard
Enable debug logging for troubleshooting purposes:
void showLogs() async {
await Flyreel.enableLogs();
}
copied to clipboard
Sandbox #
Verify your implementation in the sandbox mode. Initialize Flyreel with an additional parameter:
void main() async {
WidgetsFlutterBinding.ensureInitialized();
// ...
var configuration = FlyreelConfiguration(
organizationId = "7d3899f1421a7650241516475",
settingsVersion = 1,
environment = FlyreelEnvironment.Sandbox
);

await Flyreel.initialize(
application = this,
configuration = configuration
);

// ...
}
copied to clipboard