flutter_openim_sdk #

A flutter im plugin for android and ios.

中文文档

demo | widget

Getting Started #

1，Add dependency in yaml

   flutter_openim_sdk: latest

2，Import package

  import 'package:flutter_openim_sdk/flutter_openim_sdk.dart';

3， Init config

		// Initialize SDK
    OpenIM.iMManager
      ..initSDK(
        platform: Platform.isAndroid ? IMPlatform.android : IMPlatform.ios,
        apiAddr: '',
        wsAddr: '',
        dataDir: '',
        listener: OnConnectListener(),
      )
      // Set up current user info changed listener
      ..userManager.setUserListener(OnUserListener())
      // Add message listener (remove when not in use)
      ..messageManager.setAdvancedMsgListener(OnAdvancedMsgListener())

      // Set up message sending progress listener
      ..messageManager.setMsgSendProgressListener(OnMsgSendProgressListener())

      // Set up friend relationship listener
      ..friendshipManager.setFriendshipListener(OnFriendshipListener())

      // Set up conversation listener
      ..conversationManager.setConversationListener(OnConversationListener())

      // Set up group listener
      ..groupManager.setGroupListener(OnGroupListener(
      ));

4， Log in

 OpenIM.iMManager.login(uid: uid, token: token).then((value){
 	// login success
 });

5，Get a list of conversations

 OpenIM.iMManager.conversationManager.getAllConversationList().then((list) {
 });

6，Get friend list

 OpenIM.iMManager.friendshipManager.getFriendList().then((list) {
 });

7，Get chat history

  // If userID is not null and groupID is null, get a single chat message list
  // If the userID is null and the groupID is not null, get a group chat message list
  OpenIM.iMManager.messageManager.getHistoryMessageList(
          userID: uid,//User id
          startMsg: startMsg,//Last message, take chatMsgList[0]
          groupID: gid,//Group id
          count: count,//Page Size
      )
      .then((list){});
      

8，Send a message

// Create message
var message = await OpenIM.iMManager.messageManager.createTextMessage(
     text: 'I am the content of the message',
 );
// Send
OpenIM.iMManager.messageManager.sendMessage(
   message: message,
   offlinePushInfo: offlinePushInfo,
   userID: uid, // Single chat value is not null
   groupID: gid, // The group chat value is not null
 ).then((v) {
 }).catchError((e){
 });

9，Sign out

OpenIM.iMManager.logout();

OpenIM.iMManager

OpenIM.userManager

OpenIM.iMManager.conversationManager

OpenIM.iMManager.friendshipManager

OpenIM.iMManager.messageManager

OpenIM.iMManager.groupManager

Other

Message type

  static const text = 101;
  static const picture = 102;
  static const voice = 103;
  static const video = 104;
  static const file = 105;
  static const at_text = 106;
  static const merger = 107;
  static const card = 108;
  static const location = 109;
  static const custom = 110;
  static const revoke = 111;
  static const has_read_receipt = 112;
  static const typing = 113;
  static const quote = 114;

  ///
  static const accept_friend = 201;
  static const add_friend = 202;
  static const refuse_friend_application = 203;
  static const set_self_info = 204;
  static const revoke_message = 205;
  static const c2c_message_as_read = 206;

  static const kick_online = 303;


  static const transfer_group_owner = 501;
  static const create_group = 502;
  // static const create_group = 503;
  static const join_group = 504;
  static const quit_group = 505;
  static const set_group_info = 506;
  static const accept_group_application = 507;
  static const refuse_group_application = 508;
  static const kick_group_member = 509;
  static const invited_user_to_group = 510;

Platform

  static const ios = 1;
  static const android = 2;
  static const windows = 3;
  static const xos = 4;
  static const web = 5;
  static const mini_web = 6;
  static const linux = 7;

Group member role level

  static const member = 1;
  static const owner = 2;
  static const admin = 3;

Conversation type

 static const single = 1;
 static const group = 2;

Message status

 static const sending = 1;
 static const succeeded = 2;
 static const failed = 3;
 static const deleted = 4;