Flutter iOS通信插件intercom_ios的使用

Flutter iOS通信插件intercom_ios的使用

intercom_ios

intercom_ios 是 intercom_flutter_plugin 的 iOS 实现。

使用

此插件已被推荐使用，这意味着你可以直接使用 intercom_flutter_plugin。当你这样做时，此插件会自动包含在你的应用中，因此你不需要在 pubspec.yaml 中添加它。

但是，如果你导入此包以直接使用其 API，则应像往常一样将其添加到 pubspec.yaml 中。

以下是一个完整的示例，展示如何在 Flutter 应用中使用 intercom_ios 插件。

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:intercom_platform_interface/intercom_platform_interface.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // TODO: 确保添加你的 Intercom 工作区的密钥。
  await IntercomPlatform.instance.initialize(
    appId: 'your_app_id',
    iosApiKey: 'your_ios_api_key',
  );
  runApp(const MaterialApp(home: HomePage()));
}

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

  @override
  State<HomePage> createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  StreamSubscription<dynamic>? _streamSubscription;

  @override
  void dispose() {
    _streamSubscription?.cancel();
    super.dispose();
  }

  @override
  void initState() {
    super.initState();
    // 监听未读消息流
    _streamSubscription = IntercomPlatform.instance.getUnreadStream().listen(
          (event) => debugPrint('UnreadStream EVENT: $event'),
          onError: (e, stack) => debugPrint('UnreadStream ERROR: $e; stack: $stack'),
          onDone: () => debugPrint('UnreadStream DONE'),
        );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Intercom 示例应用'),
      ),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            // 显示消息中心按钮
            TextButton(
              onPressed: () {
                IntercomPlatform.instance.logout();
                IntercomPlatform.instance.loginIdentifiedUser(
                  userId: '123456789',
                  email: 'example@gmail.com',
                  statusCallback: IntercomStatusCallback(
                    onSuccess: () async {
                      await IntercomPlatform.instance.displayMessenger();
                      await Future.delayed(const Duration(seconds: 5), () {
                        IntercomPlatform.instance.hideMessenger();
                      });
                    },
                    onFailure: (IntercomError error) {
                      debugPrint(error.toString());
                    },
                  ),
                );
              },
              child: const Text('显示消息中心'),
            ),
            // 显示启动器按钮
            TextButton(
              onPressed: () {
                IntercomPlatform.instance.setLauncherVisibility(IntercomVisibility.visible);
              },
              child: const Text('显示启动器'),
            ),
            // 隐藏启动器按钮
            TextButton(
              onPressed: () {
                IntercomPlatform.instance.setLauncherVisibility(IntercomVisibility.gone);
              },
              child: const Text('隐藏启动器'),
            ),
            // 显示帮助中心按钮
            TextButton(
              onPressed: () {
                IntercomPlatform.instance.displayHelpCenter();
              },
              child: const Text('显示帮助中心'),
            ),
          ],
        ),
      ),
    );
  }
}

说明

1. 初始化：

   await IntercomPlatform.instance.initialize(
     appId: 'your_app_id',
     iosApiKey: 'your_ios_api_key',
   );
   

   在 main 函数中调用 initialize 方法来初始化插件，并传入你的应用 ID 和 iOS API 密钥。

2. 监听未读消息流：

   _streamSubscription = IntercomPlatform.instance.getUnreadStream().listen(
         (event) => debugPrint('UnreadStream EVENT: $event'),
         onError: (e, stack) => debugPrint('UnreadStream ERROR: $e; stack: $stack'),
         onDone: () => debugPrint('UnreadStream DONE'),
       );
   

   初始化时订阅未读消息流，并在收到事件、错误或完成时进行处理。

3. 显示和隐藏消息中心：

   onPressed: () {
     IntercomPlatform.instance.logout();
     IntercomPlatform.instance.loginIdentifiedUser(
       userId: '123456789',
       email: 'example@gmail.com',
       statusCallback: IntercomStatusCallback(
         onSuccess: () async {
           await IntercomPlatform.instance.displayMessenger();
           await Future.delayed(const Duration(seconds: 5), () {
             IntercomPlatform.instance.hideMessenger();
           });
         },
         onFailure: (IntercomError error) {
           debugPrint(error.toString());
         },
       ),
     );
   }
   

   这段代码展示了如何登录并显示消息中心，5秒后隐藏消息中心。

4. 显示和隐藏启动器：

   onPressed: () {
     IntercomPlatform.instance.setLauncherVisibility(IntercomVisibility.visible);
   }
   

   onPressed: () {
     IntercomPlatform.instance.setLauncherVisibility(IntercomVisibility.gone);
   }
   

   这两段代码分别用于显示和隐藏启动器。

5. 显示帮助中心：

   onPressed: () {
     IntercomPlatform.instance.displayHelpCenter();
   }