Flutter功能插件flyreel_sdk_flutter的使用

Flyreel Flutter SDK

要求

Android

• Android 6+ (minSdk 23)
• compileSdkVersion 34

iOS

• iOS 13+

安装

使用flutter安装

$ flutter pub add flyreel_sdk_flutter

路径依赖

通过ssh:

flyreel_sdk_flutter:
  git:
    url: git@github.com:Flyreel/flyreel-sdk-flutter.git

或者通过https:

flyreel_sdk_flutter:
  git:
    url: https://github.com/Flyreel/flyreel-sdk-flutter.git

使用

iOS权限设置

由于SDK积极使用iOS系统的某些功能，因此您需要在Info.plist文件中提供一些权限设置。

<dict>
    // ...
    <key>NSCameraUsageDescription</key>
    <string>我们需要访问摄像头。</string>
    <key>NSMicrophoneUsageDescription</key>
    <string>我们需要访问麦克风。</string>
    <key>NSLocationWhenInUseUsageDescription</key>
    <string>我们需要访问您的位置数据。</string>
</dict>

初始化

要使用Flyreel SDK，您必须提供一个包含以下参数的配置对象：

• settingsVersion: 远程SDK设置的标识符。
• organizationId: 组织的标识符。

在lib/main.dart文件中，使用提供的对象初始化Flyreel：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化Flyreel，传入organizationId和settingsVersion
  var config = FlyreelConfig(
    organizationId: "5d3633f9103a930011996475",
    settingsVersion: 1,
  );
  await Flyreel.initialize(config);

  runApp(const MyApp());
}

如何打开Flyreel聊天

调用openFlyreel()

void openFlyreel() async {
  await Flyreel.open();
}

深度链接

如果您是从深度链接、推送通知或自定义解决方案启动Flyreel流程，并且可以自动提供用户详细信息，请使用以下方法：

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");
}

自定义字体

如果您想为Flyreel聊天使用自定义字体，您需要为iOS和Android平台提供ttf文件。

• 在Android目录中，您可以将ttf文件放在main/assets或main/res/font文件夹中。
• 对于iOS，您需要遵循Apple的指南来添加自定义字体到项目中。

然后，您可以在Flyreel仪表板面板中使用字体名称。例如，如果您已将字体my_font.ttf添加到assets文件夹中，您可以在Flyreel仪表板中使用my_font作为字体名称。

调试日志

启用调试日志以供排错用途：

void showLogs() async {
  await Flyreel.enableLogs();
}

检查Flyreel状态（根据提供的访问码和邮政编码）

您可以手动检查Flyreel的状态。此函数会向服务器发起网络请求，以获取指定邮政编码和访问码下Flyreel的状态。

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}");
  }
}

沙盒模式

验证您的实现是否正确。使用附加参数初始化Flyreel：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // ...

  var configuration = FlyreelConfiguration(
      organizationId: "7d3899f1421a7650241516475",
      settingsVersion: 1,
      environment: FlyreelEnvironment.Sandbox
  );

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

  // ...
}

示例代码

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flyreel_sdk_flutter/flyreel_sdk_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化Flyreel，传入organizationId和settingsVersion
  await Flyreel.initialize(FlyreelConfig(
    organizationId: "your_organization_id",
    settingsVersion: 1,
  ));

  // 显示Flyreel日志
  Flyreel.enableLogs();
  runApp(const MyApp());
}

class MyApp extends StatefulWidget {
  const MyApp({super.key});

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _messengerKey = GlobalKey<ScaffoldMessengerState>();

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      scaffoldMessengerKey: _messengerKey,
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Flyreel插件示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.center,
            children: [
              ElevatedButton(
                child: const Text('打开Flyreel'),
                onPressed: () async {
                  await Flyreel.open();
                },
              ),
              const SizedBox(
                height: 50,
              ),
              ElevatedButton(
                child: const Text('通过URL打开Flyreel'),
                onPressed: () async {
                  // 使用深度链接字符串打开
                  await Flyreel.open(
                      deeplinkUrl:
                          "https://your.custom.url/?flyreelAccessCode=6M4T0T&flyreelZipCode=80212");
                },
              ),
              const SizedBox(
                height: 50,
              ),
              ElevatedButton(
                child: const Text('通过凭证打开Flyreel'),
                onPressed: () async {
                  // 使用邮政编码和访问码打开
                  await Flyreel.openWithCredentials(
                      zipCode: "80212",
                      accessCode: "6M4T0T",
                      shouldSkipLoginPage: false);
                },
              ),
              const SizedBox(
                height: 50,
              ),
              ElevatedButton(
                child: const Text('检查状态'),
                onPressed: () async {
                  // 使用邮政编码和访问码检查状态
                  try {
                    final result = await Flyreel.checkStatus(
                      zipCode: "80212",
                      accessCode: "6M4T0T",
                    );
                    _messengerKey.currentState?.showSnackBar(SnackBar(
                      content: Text("Status: ${result.status}, expires: ${result.expiration}"),
                    ));
                  } on PlatformException catch (e) {
                    _messengerKey.currentState?.showSnackBar(SnackBar(
                      content: Text("code: ${e.code}, message: ${e.message}"),
                    ));
                  }
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}