ex_im_flutter_chat 0.0.8 copy "ex_im_flutter_chat: ^0.0.8" to clipboard
ex_im_flutter_chat: ^0.0.8 copied to clipboard

A Flutter plugin for enterprise instant messaging - provides complete IM functionality including messaging, friends, groups, and conversations.

ex_im_flutter_chat #

ExIm Flutter Chat SDK - 企业级即时通讯 Flutter 插件。

功能特性 #

  • 用户认证与会话管理
  • 好友关系管理
  • 群组管理
  • 消息收发(文本、图片、视频、语音)
  • 会话列表管理
  • 实时消息推送(WebSocket)
  • 端到端加密支持

安装 #

pubspec.yaml 中添加依赖:

dependencies:
  ex_im_flutter_chat: ^0.0.4

快速开始 #

1. 初始化 SDK #

import 'package:ex_im_flutter_chat/ex_im_flutter_chat.dart';

// 初始化 SDK
ExImChat.instance.init(tenantId: 'your_tenant_id');

2. 登录 #

// 使用邮箱登录
await ExImChat.instance.loginWithEmail(
  email: 'user@example.com',
  password: 'password',
);

// 连接 WebSocket
await ExImChat.instance.connect();

3. 监听状态 #

// 监听 SDK 状态变化
ExImChat.instance.stateStream.listen((state) {
  print('SDK 状态: $state');
});

// 监听用户信息变化
ExImChat.instance.userService.userInfoStream.listen((userInfo) {
  print('用户: ${userInfo.nickname}');
});

// 监听新消息
ExImChat.instance.messageService.newMessageStream.listen((message) {
  print('新消息: ${message.content}');
});

4. 发送消息 #

// 发送文本消息
await MessageApi.send(MessageSendDto(
  conversationType: ConversationTypeEnum.c2c,
  targetId: 'user_id',
  type: MessageBasicTypeEnum.text,
  textData: TextData(text: 'Hello!'),
));

5. 获取会话列表 #

final conversations = await ConversationApi.list(CommonPageDto(page: 1, pageSize: 20));

6. 登出 #

await ExImChat.instance.logout();

API 文档 #

ExImChat #

方法 说明
init(tenantId) 初始化 SDK
loginWithEmail(email, password) 邮箱登录
connect() 连接 WebSocket
logout() 登出
dispose() 释放资源

服务 #

  • UserService - 用户信息管理
  • MessageService - 消息管理
  • ConversationService - 会话管理

API #

  • UserApi - 用户相关 API
  • FriendApi - 好友相关 API
  • GroupApi - 群组相关 API
  • MessageApi - 消息相关 API
  • ConversationApi - 会话相关 API
  • FileApi - 文件上传 API

平台支持 #

平台 支持
Android
iOS

注意事项 #

  • 使用前必须调用 init() 初始化 SDK
  • 登录后需要调用 connect() 建立 WebSocket 连接
  • 退出应用前请调用 logout()dispose() 释放资源

License #

MIT License

1
likes
125
points
301
downloads

Publisher

unverified uploader

Weekly Downloads

A Flutter plugin for enterprise instant messaging - provides complete IM functionality including messaging, friends, groups, and conversations.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

asn1lib, cached_network_image, dio, encrypt, flutter, flutter_cache_manager, flutter_screenutil, hive, hive_flutter, path, path_provider, pointycastle, socket_io_client, uuid

More

Packages that depend on ex_im_flutter_chat

Packages that implement ex_im_flutter_chat