IM即时通讯

监听器(Callback)

OnConnectListener

SDK 连接状态监听器,通过 CRIM.iMManager.setConnectListener 设置。

class OnConnectListener {
  Function(int? code, String? errorMsg)? onConnectFailed;
  Function()? onConnectSuccess;
  Function()? onConnecting;
  Function()? onKickedOffline;
  Function()? onUserTokenExpired;
  Function(String? data)? onUserTokenInvalid;
}

设置方式:

CRIM.iMManager.setConnectListener(OnConnectListener(
  onConnecting: () {
    // SDK 正在连接服务器
  },
  onConnectSuccess: () {
    // SDK 已成功连接到服务器
  },
  onConnectFailed: (code, errorMsg) {
    // SDK 连接服务器失败
  },
  onKickedOffline: () {
    // 当前用户被踢下线
  },
  onUserTokenExpired: () {
    // 登录票据过期,需要重新登录
  },
  onUserTokenInvalid: (data) {
    // 登录票据无效
  },
));

onConnecting

SDK 正在连接到服务器

Function()? onConnecting;

onConnectSuccess

SDK 已经成功连接到服务器

Function()? onConnectSuccess;

onConnectFailed

SDK 连接服务器失败

Function(int? code, String? errorMsg)? onConnectFailed;
  • 回调参数:
参数 类型 含义
code int 失败错误码
errorMsg String 失败错误描述

onKickedOffline

当前用户被踢下线,此时可以 UI 提示用户

Function()? onKickedOffline;

onUserTokenExpired

在线时票据过期,需要重新登录

Function()? onUserTokenExpired;

onUserTokenInvalid

登录票据无效

Function(String? data)? onUserTokenInvalid;
  • 回调参数:
参数 类型 含义
data String 错误描述

OnConversationListener

会话监听器,通过 CRIM.iMManager.conversationManager.setConversationListener 设置。

class OnConversationListener {
  Function(List<ConversationInfo> list)? onConversationChanged;
  Function(List<ConversationInfo> list)? onNewConversation;
  Function(int count)? onTotalUnreadMsgCountChanged;
  Function()? onSyncServerFailed;
  Function()? onSyncServerFinish;
  Function(int progress)? onSyncServerProgress;
  Function()? onSyncServerStart;
}

设置方式:

CRIM.iMManager.conversationManager.setConversationListener(OnConversationListener(
  onSyncServerStart: () {
    // 同步服务器会话开始
  },
  onSyncServerFinish: () {
    // 同步服务器会话完成
  },
  onSyncServerFailed: () {
    // 同步服务器会话失败
  },
  onSyncServerProgress: (progress) {
    // 同步服务器进度
  },
  onNewConversation: (list) {
    // 有新的会话
  },
  onConversationChanged: (list) {
    // 某些会话的关键信息发生变化
  },
  onTotalUnreadMsgCountChanged: (count) {
    // 会话未读总数变更通知
  },
));

syncServerStart

同步服务器会话开始

Function()? onSyncServerStart;

syncServerFinish

同步服务器会话完成

Function()? onSyncServerFinish;

syncServerFailed

同步服务器会话失败

Function()? onSyncServerFailed;

syncServerProgress

同步服务器进度

Function(int progress)? onSyncServerProgress;
  • 回调参数:
参数 类型 含义
progress int 同步进度(0~100)

newConversation

有新的会话

Function(List<ConversationInfo> list)? onNewConversation;
  • 回调参数:
参数 类型 含义
list List<ConversationInfo> 新增会话列表

conversationChanged

某些会话的关键信息发生变化

Function(List<ConversationInfo> list)? onConversationChanged;
  • 回调参数:
参数 类型 含义
list List<ConversationInfo> 变化的会话列表

totalUnreadMsgCountChanged

会话未读总数变更通知

Function(int count)? onTotalUnreadMsgCountChanged;
  • 回调参数:
参数 类型 含义
count int 未读总数

OnAdvancedMsgListener

高级消息监听器,通过 CRIM.iMManager.msgManager.setAdvancedMsgListener 添加。

class OnAdvancedMsgListener {
  Function(Message msg)? onMsgDeleted;
  Function(RevokedInfo info)? onNewRecvMsgRevoked;
  Function(List<ReadReceiptInfo> list)? onRecv1v1ReadReceipt;
  Function(Message msg)? onRecvNewMsg;
  Function(Message msg)? onRecvOfflineNewMsg;
  Function(Message msg)? onRecvOnlineOnlyMsg;
}

设置方式:

CRIM.iMManager.msgManager.setAdvancedMsgListener(OnAdvancedMsgListener(
  onRecvNewMsg: (msg) {
    // 收到新消息
  },
  onRecvOfflineNewMsg: (msg) {
    // 收到离线新消息
  },
  onRecvOnlineOnlyMsg: (msg) {
    // 收到在线消息(不存储)
  },
  onNewRecvMsgRevoked: (info) {
    // 消息被撤回
  },
  onRecv1v1ReadReceipt: (list) {
    // 单聊消息已读回执
  },
  onMsgDeleted: (msg) {
    // 消息被删除
  },
));

recvNewMsg

收到新消息

Function(Message msg)? onRecvNewMsg;
  • 回调参数:
参数 类型 含义
msg Message 新消息

recvOfflineNewMsg

收到离线新消息

Function(Message msg)? onRecvOfflineNewMsg;
  • 回调参数:
参数 类型 含义
msg Message 离线消息

recvOnlineOnlyMsg

收到在线消息(不存储本地)

Function(Message msg)? onRecvOnlineOnlyMsg;
  • 回调参数:
参数 类型 含义
msg Message 在线消息

newRecvMsgRevoked

收到消息撤回通知

Function(RevokedInfo info)? onNewRecvMsgRevoked;
  • 回调参数:
参数 类型 含义
info RevokedInfo 撤回消息信息

recv1v1ReadReceipt

单聊消息已读回执

Function(List<ReadReceiptInfo> list)? onRecv1v1ReadReceipt;
  • 回调参数:
参数 类型 含义
list List<ReadReceiptInfo> 已读回执列表

msgDeleted

收到消息被删除通知

Function(Message msg)? onMsgDeleted;
  • 回调参数:
参数 类型 含义
msg Message 被删除的消息

OnFriendshipListener

关系链监听器,通过 CRIM.iMManager.friendshipManager.setFriendshipListener 设置。

class OnFriendshipListener {
  Function(BlacklistInfo info)? onBlackAdded;
  Function(BlacklistInfo info)? onBlackDeleted;
  Function(FriendInfo info)? onFriendAdded;
  Function(FriendApplicationInfo info)? onFriendReqAccepted;
  Function(FriendApplicationInfo info)? onFriendReqAdded;
  Function(FriendApplicationInfo info)? onFriendReqDeleted;
  Function(FriendApplicationInfo info)? onFriendReqRejected;
  Function(FriendInfo info)? onFriendDeleted;
  Function(FriendInfo info)? onFriendInfoChanged;
}

设置方式:

CRIM.iMManager.friendshipManager.setFriendshipListener(OnFriendshipListener(
  onBlackAdded: (info) {
    // 黑名单新增
  },
  onBlackDeleted: (info) {
    // 黑名单删除
  },
  onFriendReqAdded: (info) {
    // 好友申请新增
  },
  onFriendReqAccepted: (info) {
    // 好友申请被接受
  },
  onFriendReqRejected: (info) {
    // 好友申请被拒绝
  },
  onFriendReqDeleted: (info) {
    // 好友申请被删除
  },
  onFriendAdded: (info) {
    // 好友新增
  },
  onFriendDeleted: (info) {
    // 好友删除
  },
  onFriendInfoChanged: (info) {
    // 好友资料变更
  },
));

blackAdded

黑名单新增通知

Function(BlacklistInfo info)? onBlackAdded;
  • 回调参数:
参数 类型 含义
info BlacklistInfo 黑名单信息

blackDeleted

黑名单删除通知

Function(BlacklistInfo info)? onBlackDeleted;
  • 回调参数:
参数 类型 含义
info BlacklistInfo 黑名单信息

friendReqAdded

好友申请新增通知

Function(FriendApplicationInfo info)? onFriendReqAdded;
  • 回调参数:
参数 类型 含义
info FriendApplicationInfo 好友申请信息

friendReqAccepted

好友申请被接受通知

Function(FriendApplicationInfo info)? onFriendReqAccepted;
  • 回调参数:
参数 类型 含义
info FriendApplicationInfo 好友申请信息

friendReqRejected

好友申请被拒绝通知

Function(FriendApplicationInfo info)? onFriendReqRejected;
  • 回调参数:
参数 类型 含义
info FriendApplicationInfo 好友申请信息

friendReqDeleted

好友申请被删除通知

Function(FriendApplicationInfo info)? onFriendReqDeleted;
  • 回调参数:
参数 类型 含义
info FriendApplicationInfo 好友申请信息

friendAdded

好友新增通知

Function(FriendInfo info)? onFriendAdded;
  • 回调参数:
参数 类型 含义
info FriendInfo 好友信息

friendDeleted

好友删除通知

Function(FriendInfo info)? onFriendDeleted;
  • 回调参数:
参数 类型 含义
info FriendInfo 好友信息

friendInfoChanged

好友资料变更通知

Function(FriendInfo info)? onFriendInfoChanged;
  • 回调参数:
参数 类型 含义
info FriendInfo 好友信息

OnGrpListener

群组监听器,通过 CRIM.iMManager.grpManager.setGrpListener 设置。

class OnGrpListener {
  Function(GroupApplicationInfo info)? onGrpReqAccepted;
  Function(GroupApplicationInfo info)? onGrpReqAdded;
  Function(GroupApplicationInfo info)? onGrpReqDeleted;
  Function(GroupApplicationInfo info)? onGrpReqRejected;
  Function(GroupInfo info)? onGrpDismissed;
  Function(GroupInfo info)? onGrpInfoChanged;
  Function(GroupMembersInfo info)? onGrpMemberAdded;
  Function(GroupMembersInfo info)? onGrpMemberDeleted;
  Function(GroupMembersInfo info)? onGrpMemberInfoChanged;
  Function(GroupInfo info)? onJoinedGrpAdded;
  Function(GroupInfo info)? onJoinedGrpDeleted;
}

设置方式:

CRIM.iMManager.grpManager.setGrpListener(OnGrpListener(
  onJoinedGrpAdded: (info) {
    // 加入新群(如被邀请),UI 列表新增 item
  },
  onJoinedGrpDeleted: (info) {
    // 退出群(如被踢),UI 列表删除 item
  },
  onGrpInfoChanged: (info) {
    // 已加入的群信息被修改
  },
  onGrpDismissed: (info) {
    // 群解散
  },
  onGrpMemberAdded: (info) {
    // 有新成员加入群
  },
  onGrpMemberDeleted: (info) {
    // 有成员离开群
  },
  onGrpMemberInfoChanged: (info) {
    // 某成员信息发生变更
  },
  onGrpReqAdded: (info) {
    // 有人申请加群
  },
  onGrpReqDeleted: (info) {
    // 群申请被删除
  },
  onGrpReqAccepted: (info) {
    // 群申请被接受
  },
  onGrpReqRejected: (info) {
    // 群申请被拒绝
  },
));

joinedGrpAdded

加入新群(如被邀请),UI 列表会新增 item

Function(GroupInfo info)? onJoinedGrpAdded;
  • 回调参数:
参数 类型 含义
info GroupInfo 群信息

joinedGrpDeleted

退出群(如被踢),UI 列表会删除这个 item

Function(GroupInfo info)? onJoinedGrpDeleted;
  • 回调参数:
参数 类型 含义
info GroupInfo 群信息

grpInfoChanged

某个已加入的群的信息被修改了

Function(GroupInfo info)? onGrpInfoChanged;
  • 回调参数:
参数 类型 含义
info GroupInfo 群信息

grpDismissed

群解散通知

Function(GroupInfo info)? onGrpDismissed;
  • 回调参数:
参数 类型 含义
info GroupInfo 群信息

grpMemberAdded

有新成员加入群

Function(GroupMembersInfo info)? onGrpMemberAdded;
  • 回调参数:
参数 类型 含义
info GroupMembersInfo 群成员信息

grpMemberDeleted

有成员离开群

Function(GroupMembersInfo info)? onGrpMemberDeleted;
  • 回调参数:
参数 类型 含义
info GroupMembersInfo 群成员信息

grpMemberInfoChanged

某成员信息发生变更

Function(GroupMembersInfo info)? onGrpMemberInfoChanged;
  • 回调参数:
参数 类型 含义
info GroupMembersInfo 群成员信息

grpApplicationAdded

有人申请加群

Function(GroupApplicationInfo info)? onGrpReqAdded;
  • 回调参数:
参数 类型 含义
info GroupApplicationInfo 群申请信息

grpApplicationDeleted

群申请被删除

Function(GroupApplicationInfo info)? onGrpReqDeleted;
  • 回调参数:
参数 类型 含义
info GroupApplicationInfo 群申请信息

grpApplicationAccepted

群申请被接受

Function(GroupApplicationInfo info)? onGrpReqAccepted;
  • 回调参数:
参数 类型 含义
info GroupApplicationInfo 群申请信息

grpApplicationRejected

群申请被拒绝

Function(GroupApplicationInfo info)? onGrpReqRejected;
  • 回调参数:
参数 类型 含义
info GroupApplicationInfo 群申请信息

OnUserListener

用户信息监听器,通过 CRIM.iMManager.setUserListener 设置。

class OnUserListener {
  Function(UserInfo info)? onSelfInfoUpdated;
  Function(LocalUserCommand info)? onUserCommandAdd;
  Function(LocalUserCommand info)? onUserCommandDelete;
  Function(LocalUserCommand info)? onUserCommandUpdate;
  Function(UserStatusInfo info)? onUserStatusChanged;
}

设置方式:

CRIM.iMManager.setUserListener(OnUserListener(
  onSelfInfoUpdated: (info) {
    // 用户信息已更新
  },
  onUserStatusChanged: (info) {
    // 用户状态变更
  },
));

selfInfoUpdated

当前登录用户信息发生变更

Function(UserInfo info)? onSelfInfoUpdated;
  • 回调参数:
参数 类型 含义
info UserInfo 用户信息

userStatusChanged

用户在线状态变更

Function(UserStatusInfo info)? onUserStatusChanged;
  • 回调参数:
参数 类型 含义
info UserStatusInfo 用户状态信息

userCommandAdd

用户命令新增

Function(LocalUserCommand info)? onUserCommandAdd;
  • 回调参数:
参数 类型 含义
info LocalUserCommand 用户命令信息

userCommandDelete

用户命令删除

Function(LocalUserCommand info)? onUserCommandDelete;
  • 回调参数:
参数 类型 含义
info LocalUserCommand 用户命令信息

userCommandUpdate

用户命令更新

Function(LocalUserCommand info)? onUserCommandUpdate;
  • 回调参数:
参数 类型 含义
info LocalUserCommand 用户命令信息