Callback
Callback
CRIMFailureCallback
请求失败的回调函数
typedef void (^CRIMFailureCallback)(NSInteger code, NSString * _Nullable msg);
| 参数 |
类型 |
含义 |
| code |
NSInteger |
请求结果错误码 |
| msg |
NSString |
请求结果错误描述 |
CRIMSuccessCallback
请求成功的回调函数
typedef void (^CRIMSuccessCallback)(NSString * _Nullable data);
| 参数 |
类型 |
含义 |
| data |
NSString |
请求结果 |
CRIMVoidCallback
无返回值的成功回调
typedef void (^CRIMVoidCallback)(void);
CRIMNumberCallback
返回数值的成功回调
typedef void (^CRIMNumberCallback)(NSInteger number);
| 参数 |
类型 |
含义 |
| number |
NSInteger |
请求结果 |
CRIMBoolCallback
无返回值的成功回调
typedef void (^CRIMBoolCallback)(BOOL result);
CRIMStringCallback
返回字符串的成功回调
typedef void (^CRIMStringCallback)(NSString * _Nullable item);
| 参数 |
类型 |
含义 |
| item |
NSString |
请求结果 |
CRIMStringArrayCallback
返回字符串数组的成功回调
typedef void (^CRIMStringArrayCallback)(NSArray<NSString *> * _Nullable value);
| 参数 |
类型 |
含义 |
| value |
NSArray<NSString *> |
请求结果 |
CRIMObjectCallback
返回字典的成功回调
typedef void (^CRIMObjectCallback)(NSDictionary * _Nullable item);
| 参数 |
类型 |
含义 |
| item |
NSDictionary |
请求结果 |
CRIMSimpleResultsCallback
typedef void (^CRIMSimpleResultsCallback)(NSArray <CRIMSimpleResultInfo *> * _Nullable results);
CRIMUserInfoCallback
typedef void (^CRIMUserInfoCallback)(CRIMUserInfo * _Nullable userInfo);
CRIMUsersInfoCallback
typedef void (^CRIMUsersInfoCallback)(NSArray <CRIMUserInfo *> * _Nullable usersInfo);
CRIMUserStatusInfoCallback
typedef void (^CRIMUserStatusInfoCallback)(CRIMUserStatusInfo * _Nullable statusInfo);
CRIMFullUsersInfoCallback
typedef void (^CRIMFullUsersInfoCallback)(NSArray <CRIMFullUserInfo *> * _Nullable userInfos);
CRIMFriendReqCallback
typedef void (^CRIMFriendReqCallback)(CRIMFriendReq * _Nullable friendReq);
CRIMFriendReqsCallback
typedef void (^CRIMFriendReqsCallback)(NSArray <CRIMFriendReq *> * _Nullable friendReqs);
CRIMFriendInfoCallback
typedef void (^CRIMFriendInfoCallback)(CRIMFriendInfo * _Nullable friendInfo);
CRIMBlackInfoCallback
typedef void (^CRIMBlackInfoCallback)(CRIMBlackInfo * _Nullable blackInfo);
CRIMBlacksInfoCallback
typedef void (^CRIMBlacksInfoCallback)(NSArray <CRIMBlackInfo *> * _Nullable blackInfos);
CRIMSearchUsersInfoCallback
typedef void (^CRIMSearchUsersInfoCallback)(NSArray<CRIMSearchFriendsInfo *> * _Nullable usersInfo);
CRIMGroupReqCallback
typedef void (^CRIMGroupReqCallback)(CRIMGroupReqInfo * _Nullable groupReq);
CRIMGroupsReqCallback
typedef void (^CRIMGroupsReqCallback)(NSArray <CRIMGroupReqInfo *> * _Nullable groupsInfo);
CRIMGroupInfoCallback
typedef void (^CRIMGroupInfoCallback)(CRIMGroupInfo * _Nullable groupInfo);
CRIMGroupsInfoCallback
typedef void (^CRIMGroupsInfoCallback)(NSArray <CRIMGroupInfo *> * _Nullable groupsInfo);
CRIMGroupMemberInfoCallback
typedef void (^CRIMGroupMemberInfoCallback)(CRIMGroupMemberInfo * _Nullable groupMemberInfo);
CRIMGroupMembersInfoCallback
typedef void (^CRIMGroupMembersInfoCallback)(NSArray <CRIMGroupMemberInfo *> * _Nullable groupMembersInfo);
CRIMConversationsInfoCallback
typedef void (^CRIMConversationsInfoCallback)(NSArray <CRIMConversationInfo *> * _Nullable conversations);
CRIMConversationInfoCallback
typedef void (^CRIMConversationInfoCallback)(CRIMConversationInfo * _Nullable conversation);
CRIMConversationNotDisturbInfoCallback
typedef void (^CRIMConversationNotDisturbInfoCallback)(NSArray <CRIMConversationNotDisturbInfo *> * _Nullable conversations);
CRIMMessageInfoCallback
typedef void (^CRIMMessageInfoCallback)(CRIMMessageInfo * _Nullable message);
CRIMMessageSearchCallback
typedef void (^CRIMMessageSearchCallback)(CRIMSearchResultInfo * _Nullable result);
CRIMReceiptCallback
typedef void (^CRIMReceiptCallback)(NSArray <CRIMReceiptInfo *> * _Nullable msgReceiptList);
CRIMRevokedCallback
typedef void (^CRIMRevokedCallback)(CRIMMessageRevokedInfo * _Nullable msgRovoked);
CRIMGetAdvancedHistoryMessageListCallback
typedef void (^CRIMGetAdvancedHistoryMessageListCallback)(CRIMGetAdvancedHistoryMessageListInfo * _Nullable result);
typedef void (^CRIMInputStatusChangedCallback)(CRIMInputStatusChangedData * _Nullable inputStatusChangedData);
CRIMSDKListener
onConnecting
SDK 正在连接到服务器
- (void)onConnecting;
onConnectSuccess
SDK 已经成功连接到服务器
- (void)onConnectSuccess;
onConnectFailed
SDK 连接服务器失败
- (void)onConnectFailed:(NSInteger)code err:(NSString*)err;
| 参数 |
类型 |
含义 |
| code |
NSInteger |
失败错误码 |
| err |
NSString |
失败错误描述 |
onKickedOffline
当前用户被踢下线,此时可以 UI 提示用户
- (void)onKickedOffline;
addIMSDKListener
添加 IM 监听
- (void)addIMSDKListener:(id<CRIMSDKListener>)listener;
removeIMSDKListener
移除 IM 监听
- (void)removeIMSDKListener:(id<CRIMSDKListener>)listener;
CRIMUserListener
onSelfInfoUpdated
用户信息改变
- (void)onSelfInfoUpdated:(CRIMUserInfo *)info;
onUserStatusChanged
用户状态更改
- (void)onUserStatusChanged:(CRIMUserStatusInfo *)info;
CRIMFriendshipListener
onBlackAdded
黑名单新增通知
- (void)onBlackAdded:(CRIMBlackInfo *)info;
onBlackDeleted
黑名单删除通知
- (void)onBlackDeleted:(CRIMBlackInfo *)info;
onFriendReqAdded
好友申请新增通知
- (void)onFriendReqAdded:(CRIMFriendReq *)req;
onFriendReqRejected
好友申请被拒绝
- (void)onFriendReqRejected:(CRIMFriendReq *)req;
onFriendReqAccepted
好友申请被接受
- (void)onFriendReqAccepted:(CRIMFriendReq *)req;
onFriendReqDeleted
好友申请被删除
- (void)onFriendReqDeleted:(CRIMFriendReq *)req;
onFriendAdded
好友新增通知
- (void)onFriendAdded:(CRIMFriendInfo *)info;
onFriendDeleted
好友删除通知
- (void)onFriendDeleted:(CRIMFriendInfo *)info;
onFriendInfoChanged
好友资料变更通知
- (void)onFriendInfoChanged:(CRIMFriendInfo *)info;
addFriendListener
添加关系链监听器
- (void)addFriendListener:(id<CRIMFriendshipListener>)listener NS_SWIFT_NAME(addFriendListener(listener:));
removeFriendListener
移除关系链监听器
- (void)removeFriendListener:(id<CRIMFriendshipListener>)listener NS_SWIFT_NAME(removeFriendListener(listener:));
CRIMGroupListener
onGrpMemberAdded
有新成员加入群
- (void)onGrpMemberAdded:(CRIMGroupMemberInfo *)memberInfo;
onGrpMemberDeleted
有成员离开群
- (void)onGrpMemberDeleted:(CRIMGroupMemberInfo *)memberInfo;
onGrpMemberInfoChanged
某成员信息发生变更
- (void)onGrpMemberInfoChanged:(CRIMGroupMemberInfo *)changeInfo;
onJoinedGrpAdded
例如有邀请进群, UI列表会展示新的item
- (void)onJoinedGrpAdded:(CRIMGroupInfo *)groupInfo;
onJoinedGrpDeleted
例如群里被踢, UI列表会删除这个的item
- (void)onJoinedGrpDeleted:(CRIMGroupInfo *)groupInfo;
onGrpInfoChanged
某个已加入的群的信息被修改了
- (void)onGrpInfoChanged:(CRIMGroupInfo *)changeInfo;
onGrpReqAccepted
群申请被接受
- (void)onGrpReqAccepted:(CRIMGroupReqInfo *)groupReq;
onGrpReqAdded
有人申请加群
- (void)onGrpReqAdded:(CRIMGroupReqInfo *)groupReq;
onGrpReqDeleted
群申请有删除
- (void)onGrpReqDeleted:(CRIMGroupReqInfo *)groupReq;
onGrpReqRejected
群申请有拒绝
- (void)onGrpReqRejected:(CRIMGroupReqInfo *)groupReq;
onGrpDismissed
群解散
- (void)onGrpDismissed:(CRIMGroupInfo *)changeInfo;
addGroupListener
设置群组监听器
- (void)addGroupListener:(id<CRIMGroupListener>)listener NS_SWIFT_NAME(addGroupListener(listener:));
removeGroupListener
移除关系链监听器
- (void)removeGroupListener:(id<CRIMGroupListener>)listener NS_SWIFT_NAME(removeGroupListener(listener:));
CRIMConversationListener
onSyncServerStart
同步服务器会话开始
- (void)onSyncServerStart;
onSyncServerFinish
同步服务器会话完成
- (void)onSyncServerFinish;
onSyncServerFailed
同步服务器会话失败
- (void)onSyncServerFailed;
onNewConversation
有新的会话
- (void)onNewConversation:(NSArray <CRIMConversationInfo *> *)conversations;
onConversationChanged
某些会话的关键信息发生变化
- (void)onConversationChanged:(NSArray <CRIMConversationInfo *> *)conversations;
onTotalUnreadMessageCountChanged
会话未读总数变更通知
- (void)onTotalUnreadMsgCountChanged:(NSInteger)totalUnreadCount;
| 参数 |
类型 |
含义 |
| totalUnreadCount |
NSInteger |
未读总数 |
addConversationListener
添加会话监听器
- (void)addConversationListener:(id<CRIMConversationListener>)listener NS_SWIFT_NAME(addConversationListener(listener:));
removeConversationListener
移除会话监听器
- (void)removeConversationListener:(id<CRIMConversationListener>)listener NS_SWIFT_NAME(removeConversationListener(listener:));
CRIMAdvancedMsgListener
onRecvNewMsg
收到新消息
- (void)onRecvNewMsg:(CRIMMessageInfo *)msg;
onRecv1v1ReadReceipt
单聊消息已读回执
- (void)onRecv1v1ReadReceipt:(NSArray<CRIMReceiptInfo *> *)receiptList;
onRecvGrpReadReceipt
群聊消息已读回执
- (void)onRecvGrpReadReceipt:(NSArray<CRIMReceiptInfo *> *)grpMsgReceiptList;
onRecvMsgRevoked
收到消息撤回
- (void)onRecvMsgRevoked:(CRIMMessageRevokedInfo *)msgRevoked;
onMsgDeleted
收到消息删除
- (void)onMsgDeleted:(CRIMMessageInfo *)message;
addAdvancedMsgListener
添加高级消息的事件监听器
- (void)addAdvancedMsgListener:(id<CRIMAdvancedMsgListener>)listener NS_SWIFT_NAME(addAdvancedMsgListener(listener:));
removeAdvancedMsgListener
移除高级消息的事件监听器
- (void)removeAdvancedMsgListener:(id<CRIMAdvancedMsgListener>)listener NS_SWIFT_NAME(removeAdvancedMsgListener(listener:));
Closure
setConnListener
设置链接状态监听器
- (void)setConnListenerWithonConnecting:(CRIMVoidCallback)onConnecting
onConnectFailure:(CRIMFailureCallback)onConnectFailure
onConnectSuccess:(CRIMVoidCallback)onConnectSuccess
onKickedOffline:(CRIMVoidCallback)onKickedOffline
onUserTokenExpired:(CRIMVoidCallback)onUserTokenExpired;
setConversationListener
设置会话监听器
- (void)setConversationListenerWithOnSyncServerStart:(CRIMBoolCallback)onSyncServerStart
onSyncServerFinish:(CRIMBoolCallback)onSyncServerFinish
onSyncServerFailed:(CRIMBoolCallback)onSyncServerFailed
onSyncServerProgress:(CRIMNumberCallback)onSyncServerProgress
onConversationChanged:(CRIMConversationsInfoCallback)onConversationChanged
onNewConversation:(CRIMConversationsInfoCallback)onNewConversation
onTotalUnreadMsgCountChanged:(CRIMNumberCallback)onTotalUnreadMsgCountChanged
onConversationUserInputStatusChanged:(nullable CRIMInputStatusChangedCallback)onConversationUserInputStatusChanged;
setFriendListener
设置会话监听器
- (void)setFriendListenerWithOnBlackAdded:(CRIMBlackInfoCallback)onBlackAdded
onBlackDeleted:(CRIMBlackInfoCallback)onBlackDeleted
onFriendReqAccepted:(CRIMFriendReqCallback)onFriendReqAccepted
onFriendReqAdded:(CRIMFriendReqCallback)onFriendReqAdded
onFriendReqDeleted:(CRIMFriendReqCallback)onFriendReqDeleted
onFriendReqRejected:(CRIMFriendReqCallback)onFriendReqRejected
onFriendInfoChanged:(CRIMFriendInfoCallback)onFriendInfoChanged
onFriendAdded:(CRIMFriendInfoCallback)onFriendAdded
onFriendDeleted:(CRIMFriendInfoCallback)onFriendDeleted;
setGroupListener
设置组监听器
- (void)setGroupListenerWithOnGroupInfoChanged:(CRIMGroupInfoCallback)onGrpInfoChanged
onJoinedGrpAdded:(CRIMGroupInfoCallback)onJoinedGrpAdded
onJoinedGrpDeleted:(CRIMGroupInfoCallback)onJoinedGrpDeleted
onGrpMemberAdded:(CRIMGroupMemberInfoCallback)onGrpMemberAdded
onGrpMemberDeleted:(CRIMGroupMemberInfoCallback)onGrpMemberDeleted
onGrpMemberInfoChanged:(CRIMGroupMemberInfoCallback)onGrpMemberInfoChanged
onGrpReqAdded:(CRIMGroupReqCallback)onGrpReqAdded
onGrpReqDeleted:(CRIMGroupReqCallback)onGrpReqDeleted
onGrpReqAccepted:(CRIMGroupReqCallback)onGrpReqAccepted
onGrpReqRejected:(CRIMGroupReqCallback)onGrpReqRejected
onGrpDismissed:(nullable CRIMGroupInfoCallback)onGrpDismissed;
setAdvancedMsgListener
设置组监听器
- (void)setAdvancedMsgListenerWithOnRecvMsgRevoked:(CRIMRevokedCallback)onRecvMsgRevoked
onRecv1v1ReadReceipt:(CRIMReceiptCallback)onRecv1v1ReadReceipt
onRecvGrpReadReceipt:(CRIMReceiptCallback)onRecvGrpReadReceipt
onRecvNewMsg:(CRIMMessageInfoCallback)onRecvNewMsg;
setSelfUserInfoUpdateListener
用户信息监听
- (void)setSelfUserInfoUpdateListener:(CRIMUserInfoCallback)onUserInfoUpdate;
- (void)setUserListenerWithUserInfoUpdate:(nullable CRIMUserInfoCallback)onUserInfoUpdate
onUserStatusChanged:(nullable CRIMUserStatusInfoCallback)onUserStatusChanged;