Flutter YouTube管理插件flutter_ytim的使用

Demonstrates how to use the flutter_ytim plugin.

概要

YouTeacher IM 快速开发SDK。 支持两种集成方式：

1. 快速集成。几行代码完成所有功能接入，使用内置UI界面。
2. 自定义集成。使用核心功能API，自定义联系人列表和聊天界面。

功能

• IM账号自动注册/登陆
• 联系人列表
• 未读消息红点显示
• 最后一条消息展示
• 1v1聊天
• 群组聊天
• 客服聊天
• 创建群组
• 修改备注
• 发送图片
• 保存图片
• 未读/已读状态显示
• 自己的消息撤回
• 被踢下线回调
• 内置UI组件国际化支持

初始化YTIM快速集成

在应用顶层集成 provide，用于界面更新：

MultiProvider(
  providers: [
    ChangeNotifierProvider(
      create: (context) => IMStore({}, {}, {}, [], [], [], []),
    ),
  ],
  child: HomePage(),
)

初始化YTIM插件

YTIM().init(
    loginToken: '',
    websocketUrl: 'wss://preim.rentalbike.shop:18081',
    onConnectErrorCallback: (WebSocketChannelException error) {},
    imLoginSuccessCallback: (IMUser user) {
      /// 获取IM总数据
      _getIMTotalData();
    },
    loginFailCallback: (int code) {
      /// 登录失败
      /// code = 412 时，token失效，需要刷新token重新登录
    },
    revokeMsgCallback: (IMCommand command) {
      /// 消息撤回
      if (mounted) {
        IMUtils.processRevokeMessage(context, command);
      }
      imEventBus.fire(
          IMEventCommand(IMEventCommandType.revokeMsg, command: command));
    },
    sysMsgCallback: (IMSysMessage msg) {
      /// 系统消息
      if (mounted) {
        IMUtils.processSysMessage(context, msg);
      }
    },
    groupControlCallback: (IMGroupControl msg) {
      /// 群组操作的消息
      if (mounted) {
        IMUtils.processGroupControlMessage(context, msg);
      }
    },
    chatMessageCallback: (IMBaseMessage message) {
      /// 聊天消息的回调，包括群组、单聊、客服  用message.chatType判断
      if (mounted) {
        IMUtils.processChatMessage(context, message);
      }
      /// demo中消息发送
      imEventBus.fire(
          IMEventCommand(IMEventCommandType.chatMsg, message: message));
    },
    logEnabled: true);

添加回调

YTIM().addKickOutCallback(() {
  /// IM异地登录操作
  YTLog.d('UI', 'IM 用户异地登录，当前用户被踢出');
});

YTIM().addMsgReadCallback((IMCommand command) {
  /// 消息已读
  /// demo中消息发送
  imEventBus
      .fire(IMEventCommand(IMEventCommandType.readMsg, command: command));
});

YTIM().addUnreadCountCallback((value) {
  /// 消息未读数量
  unreadCount = value;
  setState(() {});
});

拉取IM总数据

YTIM().getIMTotalData(context, (value) {}, (error) {});

在程序回到前台时，检查IM连接状态。

YTIM().checkConnectStatus();

断开连接，释放资源。

YTIM().release();

一些事件类型

可用的全局变量

示例代码

example project

示例代码

import 'package:flutter/material.dart';
import 'package:flutter_localizations/flutter_localizations.dart';
import 'package:flutter_ytim/flutter_ytim.dart';
import 'package:flutter_ytim_example/ui/page/im_home_page.dart';
import 'package:flutter_ytim_example/values/localizations.dart';
import 'package:provider/provider.dart';

void main() {
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MultiProvider(
      providers: [
        ChangeNotifierProvider(
            create: (context) => IMStore({}, {}, {}, [], [], [], [])),
      ],
      child: const MaterialApp(
        localizationsDelegates: [
          IMLocalizations.delegate,
          ...GlobalMaterialLocalizations.delegates,
        ],
        supportedLocales: [Locale('zh'), Locale('ja')],
        locale: Locale('zh'),
        home: Scaffold(
          body: IMHomePage(),
        ),
      ),
    );
  }
}