API参考
初始化
获取sdk版本号
+ (NSString *)sdkVersion;
- 返回值:版本号字符串
获取当前已登录用户的userID
+ (NSString *)getLoginUserID;
- 返回值:登录用户的userID
初始化SDK
- (BOOL)initSDKWithConfig:(CRIMInitConfig *)config;
-
返回值:初始化结果
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| config | CRIMInitConfig | 是 | 初始化配置结构体 |
反初始化SDK
- (void)unInitSDK;
- 返回值:无
登录
使用appId登录
- (void)login:(NSString *)userID
appId:(NSString *)appId
appSecret:(NSString *)appSecret
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户ID userID来自于自身业务服务器 |
| appId | NSString | 是 | APP ID 可在管理后台,【项目管理】获取 |
| appSecret | NSString | 是 | APP Secret 可在管理后台,【项目管理】获取,MD5后的值 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
使用token登录
- (void)login:(NSString *)userID
token:(NSString *)token
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户ID userID来自于自身业务服务器 |
| token | NSString | 是 | token生成器返回的token |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取登录状态
- (NSInteger)getLoginStatus;
- 返回值:登录状态: 1:Logout, 2:Logging, 3:Logged
登出
- (void)logoutWithOnSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
用户
根据userID批量查询用户信息
- (void)getUsersInfo:(NSArray <NSString *> *)userIDs
onSuccess:(nullable CRIMUsersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSArray<NSString *> | 是 | 用户id列表 |
| onSuccess | CRIMUsersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
修改当前登录用户信息
- (void)setSelfInfo:(CRIMUserInfo *)userInfo
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userInfo | CRIMUserInfo | 是 | 用户信息结构体 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取当前登录用户信息
- (void)getSelfInfoWithOnSuccess:(nullable CRIMUserInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMUserInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
订阅指定用户的在线状态
调用订阅用户的在线状态接口,可以订阅用户的在线状态,触发订阅者的onUserStatusChanged回调。
- (void)subscribeUsersStatus:(NSArray<NSString *> *)userIDs
onSuccess:(nullable CRIMUserStatusInfosCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSArray<NSString *> | 是 | 用户ID列表 |
| onSuccess | CRIMUserStatusInfosCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
取消订阅用户的在线状态
- (void)unsubscribeUsersStatus:(NSArray<NSString *> *)userIDs
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSArray<NSString *> | 是 | 用户ID列表 |
| onSuccess | CRIMUserInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取所有已订阅用户的在线状态
- (void)getSubscribeUsersStatusWithOnSuccess:(nullable CRIMUserStatusInfosCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMUserStatusInfosCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取指定用户的在线状态
- (void)getUserStatus:(NSArray<NSString *> *)userIDs
onSuccess:(nullable CRIMUserStatusInfosCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSArray<NSString *> | 是 | 用户ID列表 |
| onSuccess | CRIMUserStatusInfosCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
会话
获取会话列表
- (void)getAllConversationListWithOnSuccess:(nullable CRIMConversationsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMConversationsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
分页获取会话列表
- (void)getConversationListSplitWithOffset:(NSInteger)offset
count:(NSInteger)count
onSuccess:(nullable CRIMConversationsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | NSInteger | 是 | 起始偏移量 |
| count | NSInteger | 是 | 拉取会话的数量 |
| onSuccess | CRIMConversationsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取一个会话
如果不存在会自动创建
- (void)getOneConversationWithSessionType:(CRIMConversationType)sessionType
sourceID:(NSString *)sourceID
onSuccess:(nullable CRIMConversationInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| sessionType | CRIMConversationType | 是 | 会话的类型 |
| sourceID | NSString | 是 | 单聊为用户ID,群聊为群ID |
| onSuccess | CRIMConversationInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取多个会话列表
- (void)getMultipleConversation:(NSArray <NSString *> *)conversationIDs
onSuccess:(nullable CRIMConversationsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationIDs | NSArray<NSString *> | 是 | 会话ID的列表 |
| onSuccess | CRIMConversationsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
根据会话类型获取会话ID
- (NSString *)getConversationIDBySessionType:(CRIMConversationType)sessionType
sourceID:(NSString *)sourceID;
-
返回值:会话ID
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| sessionType | CRIMConversationType | 是 | 会话的类型 |
| sourceID | NSString | 是 | 单聊为用户ID,群聊为群ID |
本地删除一个会话
- (void)deleteConversationAndDeleteAllMsg:(NSString *)conversationID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
清空一个会话
本地 & 服务器
- (void)clearConversationAndDeleteAllMsg:(NSString *)conversationID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
设置会话的草稿
- (void)setConversationDraft:(NSString *)conversationID
draftText:(NSString *)draftText
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| draftText | NSString | 是 | 草稿文本,如果为""则为删除草稿 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
置顶会话
- (void)pinConversation:(NSString *)conversationID
isPinned:(BOOL)isPinned
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| isPinned | BOOL | 是 | 为YES时,代表置顶会话,为NO时代表取消置顶 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取总的消息未读数
- (void)getTotalUnreadMsgCountWithOnSuccess:(nullable CRIMNumberCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMNumberCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置会话免打扰状态
- (void)setConversationRecvMsgOpt:(NSString *)conversationID
status:(CRIMReceiveMessageOpt)status
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| status | CRIMReceiveMessageOpt | 是 | 免打扰状态 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
设置私聊
可做“阅后即焚”功能
- (void)setConversationPrivateChat:(NSString *)conversationID
isPrivate:(BOOL)isPrivate
duration:(NSInteger)burnDuration
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| isPrivate | BOOL | 是 | 是否为私聊 |
| burnDuration | NSInteger | 是 | 阅后即焚时间间隔 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
设置会话扩展信息
- (void)setConversationEx:(NSString *)conversationID
ex:(NSString *)ex
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| ex | NSString | 否 | 扩展信息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
重置at标志位
- (void)resetConversationGrpAtType:(NSString *)conversationID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
隐藏指定会话
不删除聊天记录;如果有新消息到达,会话会再次出现。
- (void)hideConversation:(NSString *)conversationID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
隐藏所有会话
不删除聊天记录;如果有新消息到达,会话会再次出现。
- (void)hideAllConversationsWithOnSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
清空未读数
调用标记已读接口,可以把会话内的消息标记为已读,对于群聊和通知会话,调用该接口可以清除未读计数,对于单聊会话,不仅会清除未读计数,还会给消息的发送方发送已读回执,触发发送方的onRecv1v1ReadReceipt回调。
- (void)markConversationMsgAsRead:(NSString *)conversationID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
通过会话名称搜索会话
- (void)searchConversation:(NSString *)name
onSuccess:(nullable CRIMConversationsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| name | NSString | 是 | 会话名称 |
| onSuccess | CRIMConversationsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
更新会话输入状态
仅使用于单聊,输入结束时,需要将focus值为false
- (void)changeInputStates:(NSString *)conversationID
focus:(BOOL)focus
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| focus | BOOL | 是 | 是否正在输入 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取输入状态
仅使用于单聊
- (void)getInputstates:(NSString *)conversationID
userID:(NSString *)userID
onSuccess:(nullable CRIMInputStatusChangedCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| userID | BOOL | NSString | 用户ID |
| onSuccess | CRIMInputStatusChangedCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
好友
添加好友
- (void)addFriend:(NSString *)userID
reqMessage:(NSString * _Nullable)reqMessage
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 对方userID |
| reqMessage | NSString | 否 | 请求消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取收到的好友申请
既哪些人申请加我为好友
- (void)getFriendReqListAsRecipient:(GetFriendReqListAsRecipientReq *)req
onSuccess:(CRIMFriendReqsCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| req | GetFriendReqListAsRecipientReq | 是 | 申请列表分页过滤结构体 |
| onSuccess | CRIMFriendReqsCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
发出的好友申请
- (void)getFriendReqListAsApplicant:(GetFriendReqListAsApplicantReq *)req
onSuccess:(CRIMFriendReqsCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| req | GetFriendReqListAsRecipientReq | 是 | 申请列表分页过滤结构体 |
| onSuccess | CRIMFriendReqsCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
同意某人的好友申请
- (void)acceptFriendReq:(NSString *)userID
handleMsg:(NSString *)msg
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| msg | NSString | 是 | 消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
拒绝好友申请
- (void)refuseFriendReq:(NSString *)userID
handleMsg:(NSString *)msg
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| msg | NSString | 是 | 消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
加入黑名单
- (void)addToBlackList:(NSString *)userID
ex:(NSString * _Nullable)ex
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| ex | NSString | 是 | 扩展信息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取黑名单
- (void)getBlackListWithOnSuccess:(nullable CRIMBlacksInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMBlacksInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
移除黑名单
- (void)removeFromBlackList:(NSString *)userID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取指定好友列表的相关信息
- (void)getSpecifiedFriendsInfo:(NSArray <NSString *> *)userIDs
filterBlack:(BOOL)filterBlack
onSuccess:(nullable CRIMFriendsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSString | 是 | 用户id列表 |
| filterBlack | BOOL | 是 | 是否过滤黑名单 |
| onSuccess | CRIMFriendsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取所有好友的相关信息
- (void)getFriendListWithFilterBlack:(BOOL)filterBlack
onSuccess:(nullable CRIMFriendsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| filterBlack | BOOL | 是 | 是否过滤黑名单 |
| onSuccess | CRIMFriendsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取所有好友的相关信息
- (void)getFriendListPageWithOffset:(NSInteger)offset
count:(NSInteger)count
filterBlack:(BOOL)filterBlack
onSuccess:(nullable CRIMFriendsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| filterBlack | BOOL | 是 | 是否过滤黑名单 |
| onSuccess | CRIMFriendsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
检查是否好友关系
即是否在登录用户的好友列表中。result为1表示好友(并且不是黑名单)
- (void)checkFriend:(NSArray <NSString *> *)userIDs
onSuccess:(nullable CRIMSimpleResultsCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userIDs | NSString | 是 | userID列表 |
| onSuccess | CRIMSimpleResultsCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置好友备注
- (void)setFriendRemark:(NSString *)userID
remark:(NSString * _Nullable)remark
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| remark | NSString | 否 | 备注信息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
设置好友扩展信息
- (void)setFriendEx:(NSString *)userID
ex:(NSString *)ex
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| ex | NSString | 否 | 扩展信息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
设置好友是否置顶
- (void)setFriendIsPinned:(NSString *)userID
isPinned:(BOOL)isPinned
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| userID | NSString | 是 | 用户id |
| isPinned | BOOL | 否 | 是否置顶 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
删除好友
好友关系是相互的,删除时将导致双方都互不为好友
- (void)deleteFriend:(NSString *)friendUserID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| friendUserID | NSString | 是 | 好友ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
本地搜索好友
- (void)searchFriends:(CRIMSearchFriendsParam *)searchParam
onSuccess:(nullable CRIMSearchUsersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| searchParam | CRIMSearchFriendsParam | 是 | 搜索好友结构体 |
| onSuccess | CRIMSearchUsersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
群组
创建群
- (void)createGrp:(CRIMGroupCreateInfo *)groupBaseInfo
onSuccess:(nullable CRIMGroupInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupBaseInfo | CRIMGroupCreateInfo | 是 | 群信息结构体 |
| onSuccess | CRIMGroupInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
申请加入群组
- (void)joinGrp:(NSString *)groupID
reqMsg:(NSString *)reqMsg
joinSource:(CRIMJoinType)joinSource
ex:(NSString * _Nullable)ex
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| reqMsg | NSString | 否 | 进群申请消息 |
| joinSource | CRIMJoinType | 是 | 进群方式 |
| ex | NSString | 否 | 进群扩展消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
退群
- (void)quitGrp:(NSString *)groupID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取已加入的群列表
- (void)getJoinedGrpListWithOnSuccess:(nullable CRIMGroupsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMGroupsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
分页获取已加入的群列表
- (void)getJoinedGrpListPageWithOffset:(NSInteger)offset
count:(NSInteger)count
onSuccess:(nullable CRIMGroupsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| offset | NSInteger | 是 | 起始偏移 |
| count | NSInteger | 是 | 每页群个数 |
| onSuccess | CRIMGroupsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取指定群资料
获取指定群的资料,支持批量获取。
- (void)getSpecifiedGrpsInfo:(NSArray <NSString *> *)groupsID
onSuccess:(nullable CRIMGroupsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupsID | NSArray<NSString *> | 是 | 群ID集合 |
| onSuccess | CRIMGroupsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
更新群资料
更新群头像、群名称、群公告、群简介等群资料,仅群主和管理员有权限。
- (void)setGrpInfo:(CRIMGroupInfo *)groupInfo
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupInfo | CRIMGroupInfo | 是 | 群信息结构体 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取群成员列表
- (void)getGrpMemberList:(NSString *)groupID
filter:(CRIMGroupMemberFilter)filter
offset:(NSInteger)offset
count:(NSInteger)count
onSuccess:(nullable CRIMGroupMembersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| filter | CRIMGroupMemberFilter | 是 | 过滤成员,0不过滤,1群的创建者,2管理员;默认值0 |
| offset | NSInteger | 是 | 起始偏移 |
| count | NSInteger | 是 | 成员个数 |
| onSuccess | CRIMGroupMembersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取群内指定群成员信息
获取群内指定的群成员信息,仅本群成员可调用。
- (void)getSpecifiedGrpMembersInfo:(NSString *)groupID
userIDs:(NSArray <NSString *> *)userIDs
onSuccess:(nullable CRIMGroupMembersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| userIDs | NSArray<NSString *> | 是 | 群成员ID |
| onSuccess | CRIMGroupMembersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
踢出群
- (void)kickGrpMember:(NSString *)groupID
reason:(NSString * _Nullable)reason
userIDs:(NSArray <NSString *> *)userIDs
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| reason | NSString | 否 | 说明 |
| userIDs | NSArray<NSString *> | 是 | 被要踢出群的用户id列表 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
转让群主
只有群主能操作
- (void)transferGrpOwner:(NSString *)groupID
newOwner:(NSString *)userID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| userID | NSString | 是 | 新群主用户ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
邀请入群
群组成员可邀请其他用户加入群组,无须对方同意,支持批量邀请。
- (void)inviteUserToGrp:(NSString *)groupID
reason:(NSString *)reason
userIDs:(NSArray <NSString *> *)userIDs
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| reason | NSString | 是 | 邀请说明 |
| userIDs | NSArray<NSString *> | 是 | 被邀请用户id列表 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
获取收到的群成员申请进群列表
作为群主或者管理员可操作
- (void)getGrpReqListAsRecipient:(GetGroupReqListAsRecipientReq *)req
onSuccess:(CRIMGroupsReqCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMGroupsReqCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
发出的入群申请
- (void)getGrpReqListAsApplicant:(GetGroupReqListAsApplicantReq *)req
onSuccess:(CRIMGroupsReqCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMGroupsReqCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
同意某人进入某群
管理员或者群主操作
- (void)acceptGrpReq:(NSString *)groupID
fromUserId:(NSString *)fromUserID
handleMsg:(NSString * _Nullable)handleMsg
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| fromUserID | NSString | 是 | 申请进群的用户ID |
| handleMsg | NSString | 否 | 处理的消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
拒绝某人进入某群
管理员或者群主操作
- (void)refuseGrpReq:(NSString *)groupID
fromUserId:(NSString *)fromUserID
handleMsg:(NSString * _Nullable)handleMsg
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| fromUserID | NSString | 是 | 申请进群的用户ID |
| handleMsg | NSString | 否 | 处理的消息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
解散群
- (void)dismissGrp:(NSString *)groupID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
禁言群成员
- (void)changeGrpMemberMute:(NSString *)groupID
userID:(NSString *)userID
mutedSeconds:(NSInteger)mutedSeconds
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群组ID |
| userID | NSString | 是 | 用户ID |
| mutedSeconds | NSInteger | 是 | 禁言时间,为0时取消禁言 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置群禁言状态
群主或管理员可以设置群禁言状态,禁言后仅群主和管理员可以发言。
- (void)changeGrpMute:(NSString *)groupID
isMute:(BOOL)isMute
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| isMute | BOOL | 是 | 是否禁言 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
搜索群
通过群名称或者群ID
- (void)searchGrps:(CRIMSearchGroupParam *)searchParam
onSuccess:(nullable CRIMGroupsInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| searchParam | CRIMSearchGroupParam | 是 | 搜索群的结构体 |
| onSuccess | CRIMGroupsInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置群成员昵称
群主可以修改管理员和普通成员的昵称,管理员可以修改普通成员的昵称。
- (void)setGrpMemberNickname:(NSString *)groupID
userID:(NSString *)userID
groupNickname:(NSString * _Nullable)groupNickname
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| userID | NSString | 是 | 用户ID |
| groupNickname | NSString | 否 | 昵称 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
修改群成员身份
群主可以修改管理员和普通成员的身份,管理员可以修改普通成员的身份。
- (void)setGrpMemberRoleLevel:(NSString *)groupID
userID:(NSString *)userID
roleLevel:(CRIMGroupMemberRole)roleLevel
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| userID | NSString | 是 | 用户ID |
| roleLevel | CRIMGroupMemberRole | 是 | 成员身份 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
根据加入时间分页获取组成员列表
- (void)getGrpMemberListByJoinTimeFilter:(NSString *)groupID
offset:(NSInteger)offset
count:(NSInteger)count
joinTimeBegin:(NSInteger)joinTimeBegin
joinTimeEnd:(NSInteger)joinTimeEnd
filterUserIDList:(NSArray <NSString *> *)filterUserIDList
onSuccess:(nullable CRIMGroupMembersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| offset | NSInteger | 是 | 开始下标 |
| count | NSInteger | 是 | 总数 |
| joinTimeBegin | NSInteger | 是 | 加入开始时间 |
| joinTimeEnd | NSInteger | 是 | 加入结束时间 |
| filterUserIDList | NSArray<NSString *> | 是 | 用户ID列表 |
| onSuccess | CRIMGroupMembersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
进群验证设置选项
- (void)setGrpVerification:(NSString *)groupID
needVerification:(CRIMGroupVerificationType)needVerification
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| needVerification | CRIMGroupVerificationType | 是 | 进群设置 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取管理者和拥有者
- (void)getGrpMemberOwnerAndAdmin:(NSString *)groupID
onSuccess:(nullable CRIMGroupMembersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| onSuccess | CRIMGroupMembersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
群成员之间是否可添加好友
- (void)setGrpApplyMemberFriend:(NSString *)groupID
rule:(int32_t)rule
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| rule | int32_t | 是 | 0: 默认可行 1: 不可行 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置能否查看群成员信息
- (void)setGrpLookMemberInfo:(NSString *)groupID
rule:(int32_t)rule
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| rule | int32_t | 是 | 0: 默认可行 1: 不可行 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
搜索群成员
- (void)searchGrpMembers:(CRIMSearchGroupMembersParam *)searchParam
onSuccess:(nullable CRIMGroupMembersInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| searchParam | CRIMSearchGroupMembersParam | 是 | 搜索的群成员结构体 |
| onSuccess | CRIMGroupMembersInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取成员ID列表是否在群里
- (void)getUsersInGrp:(NSString *)groupID
userIDs:(NSArray<NSString *> *)userIDs
onSuccess:(nullable CRIMStringArrayCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| groupID | NSString | 是 | 群ID |
| userIDs | NSArray<NSString *> | 是 | userID列表 |
| onSuccess | CRIMStringArrayCallback | 否 | 操作成功的回调,返回在群里的userID列表 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
消息
是否是发送出去的消息
- (BOOL)isSelf;
- 返回值:返回结果BOOL值,YES为是
创建文本消息
+ (CRIMMessageInfo *)createTextMsg:(NSString *)text;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | NSString | 是 | 文本内容 |
创建@所有人标识
可配套createTextMsg使用,将@所有人标识插入指定位置
+ (CRIMAtInfo *)createAtAllFlag:(NSString *)displayText;
-
返回值:@消息结构体CRIMAtInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| displayText | NSString | 是 | 展示的内容, 例如“@所有人“ |
创建@文本消息
+ (CRIMMessageInfo *)createTextAtMsg:(NSString *)text
atuserIDs:(NSArray<NSString *> *)atuserIDs
atUsersInfo:(NSArray<CRIMAtInfo *> *)atUsersInfo
message:(CRIMMessageInfo * _Nullable)message;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | NSString | 是 | 内容 |
| atuserIDs | NSArray<NSString *> | 是 | 用户id列表 |
| atUsersInfo | NSArray<CRIMAtInfo *> | 是 | 用户在群内的信息 |
| message | CRIMMessageInfo | 否 | 引用消息的时候使用 |
创建@全体成员文本消息
+ (CRIMMessageInfo *)createTextAtAllMsg:(NSString *)text
displayText:(NSString * _Nullable)displayText
message:(CRIMMessageInfo * _Nullable)message;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | NSString | 是 | 内容 |
| displayText | NSString | 否 | 展示的内容, 例如“@全体成员“ |
| message | CRIMMessageInfo | 否 | 引用消息的时候使用 |
通过本地图片路径创建图片消息
使用此接口可文件路径参数需用绝对路径
+ (CRIMMessageInfo *)createImageMsgFromFullPath:(NSString *)imagePath;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| imagePath | NSString | 是 | 绝对路径 |
通过图片URL创建图片消息
例如:自行上传的文件,然后使用返回的url构造消息
+ (CRIMMessageInfo *)createImageMsgByURL:(CRIMPictureInfo *)source
bigPicture:(CRIMPictureInfo *)big
snapshotPicture:(CRIMPictureInfo *)snapshot;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| source | CRIMPictureInfo | 是 | 图片文件信息 |
| big | CRIMPictureInfo | 是 | 大图信息 |
| snapshot | CRIMPictureInfo | 是 | 缩略图信息 |
通过本地音频路径创建音频消息
使用此接口可文件路径参数需用绝对路径
+ (CRIMMessageInfo *)createSoundMsgFromFullPath:(NSString *)soundPath
duration:(NSInteger)duration;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| soundPath | NSString | 是 | 绝对路径 |
| duration | NSInteger | 是 | 时长 |
通过音频URL创建音频消息
例如:自行上传的文件,然后使用返回的url构造消息
+ (CRIMMessageInfo *)createSoundMsgByURL:(NSString *)fileURL
duration:(NSInteger)duration
size:(NSInteger)size;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| fileURL | NSString | 是 | 音频文件URL |
| duration | NSInteger | 是 | 时长 |
| size | NSInteger | 是 | 文件大小 |
通过本地视频路径创建视频消息
使用此接口可文件路径参数需用绝对路径
+ (CRIMMessageInfo *)createVideoMsgFromFullPath:(NSString *)videoPath
videoType:(NSString *)videoType
duration:(NSInteger)duration
snapshotPath:(NSString *)snapshotPath;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| videoPath | NSString | 是 | 视频绝对路径 |
| videoType | NSString | 是 | mine type |
| duration | NSInteger | 是 | 时长 |
| snapshotPath | NSString | 是 | 缩略图绝对路径 |
通过视频URL创建视频消息
例如:自行上传的文件,然后使用返回的url构造消息
+ (CRIMMessageInfo *)createVideoMsgByURL:(NSString *)fileURL
videoType:(NSString * _Nullable)videoType
duration:(NSInteger)duration
size:(NSInteger)size
snapshot:(NSString * _Nullable)snapshotURL;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| fileURL | NSString | 是 | 文件URL |
| videoType | NSString | 否 | mine type |
| duration | NSInteger | 是 | 时长 |
| size | NSInteger | 是 | 文件大小 |
| snapshotURL | NSString | 否 | 缩略图URL |
通过本地文件路径创建文件消息
使用此接口可文件路径参数需用绝对路径
+ (CRIMMessageInfo *)createFileMsgFromFullPath:(NSString *)filePath
fileName:(NSString *)fileName;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| filePath | NSString | 是 | 文件本地的绝对路径 |
| fileName | NSString | 是 | 文件名 |
通过文件URL创建文件消息
例如:自行上传的文件,然后使用返回的url构造消息
+ (CRIMMessageInfo *)createFileMsgByURL:(NSString *)fileURL
fileName:(NSString * _Nullable)fileName
size:(NSInteger)size;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| fileURL | NSString | 是 | 文件URL |
| fileName | NSString | 否 | 文件名 |
| size | NSInteger | 是 | 文件大小 |
创建合并消息
+ (CRIMMessageInfo *)createMergerMsg:(NSArray <CRIMMessageInfo *> *)messages
title:(NSString *)title
summaryList:(NSArray <NSString *> *)summarys;
-
返回值:
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| messages | NSArray<CRIMMessageInfo *> | 是 | 消息列表 |
| title | NSString | 是 | 合并消息的标题 |
| summarys | NSArray<NSString *> | 是 | 合并消息需要显示的消息摘要列表 |
创建转发消息
+ (CRIMMessageInfo *)createForwardMsg:(CRIMMessageInfo *)message;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | CRIMMessageInfo | 是 | 消息 |
创建位置消息
+ (CRIMMessageInfo *)createLocationMsg:(NSString *)description
longitude:(double)longitude
latitude:(double)latitude;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| description | NSString | 是 | 描述消息 |
| longitude | double | 是 | 经度 |
| latitude | double | 是 | 纬度 |
创建引用消息
+ (CRIMMessageInfo *)createQuoteMsg:(NSString *)text
message:(CRIMMessageInfo *)message;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| text | NSString | 是 | 内容 |
| message | CRIMMessageInfo | 是 | 被引用的消息体 |
创建名片消息
+ (CRIMMessageInfo *)createCardMsg:(CRIMCardElem *)card;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| card | CRIMCardElem | 是 | 内容 |
创建自定义消息
+ (CRIMMessageInfo *)createCustomMsg:(NSString *)data
extension:(NSString * _Nullable)extension;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| data | NSString | 是 | 文本内容,json字符串 |
| extension | NSString | 否 | 扩展内容,json字符串 |
创建动图消息
+ (CRIMMessageInfo *)createFaceMsgWithIndex:(NSInteger)index
data:(NSString *)dataStr;
-
返回值:消息结构体CRIMMessageInfo
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| index | NSInteger | 是 | 下标 |
| dataStr | NSString | 是 | 内容 |
发送消息
发送消息需要先构造消息实例,支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、@xxx等消息,构造完消息后调用SDK的发送接口即可完成消息的发送
- (void)sendMsg:(CRIMMessageInfo *)message
recvID:(NSString * _Nullable)recvID
groupID:(NSString * _Nullable)groupID
offlinePushInfo:(CRIMOfflinePushInfo * _Nullable)offlinePushInfo
onSuccess:(nullable CRIMMessageInfoCallback)onSuccess
onProgress:(nullable CRIMNumberCallback)onProgress
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | CRIMMessageInfo | 是 | 消息体为通过Create...Message创建的CRIMMessageInfo |
| recvID | NSString | 否 | 单聊的用户ID,如果为群聊则为"" |
| groupID | NSString | 否 | 群聊的群ID,如果为单聊则为"" |
| offlinePushInfo | CRIMOfflinePushInfo | 否 | 离线推送的消息为CRIMOfflinePushInfo |
| onSuccess | CRIMMessageInfoCallback | 否 | 操作成功的回调 |
| onSuccess | CRIMNumberCallback | 否 | 发送进度的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
撤回一条消息
- (void)revokeMsg:(NSString *)conversationID
clientMsgID:(NSString *)clientMsgID
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| clientMsgID | NSString | 是 | 消息ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
单聊正在输入消息
- (void)typingStatusUpdate:(NSString *)recvID
msgTip:(NSString *)msgTip
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| recvID | NSString | 是 | 接收者的ID |
| msgTip | NSString | 是 | 自定义的提示信息 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
标记消息已读
调用标记已读接口,可以把消息标记为已读,如果是单聊会话内的消息,还会给消息的发送方发送已读回执,触发发送方的onRecv1v1ReadReceipt回调。
- (void)markMsgAsReadByMsgID:(NSString *)conversationID
clientMsgIDs:(NSArray <NSString *> *)clientMsgIDs
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| clientMsgIDs | NSArray<NSString *> | 是 | 消息ID列表 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
从本地删除一条消息
- (void)deleteMsgFromLocalStorage:(NSString *)conversationID
clientMsgID:(NSString *)clientMsgID
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| clientMsgID | NSString | 是 | 消息ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
删除一条消息
本地 & 服务器
- (void)deleteMsg:(NSString *)conversationID
clientMsgID:(NSString *)clientMsgID
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| conversationID | NSString | 是 | 会话ID |
| clientMsgID | NSString | 是 | 消息ID |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
从本地删除所有消息
- (void)deleteAllMsgFromLocalWithOnSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
删除所有消息
本地 & 服务器
- (void)deleteAllMsgFromLocalAndSvrWithOnSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
插入一条单聊消息到本地
- (void)insertSingleMsgToLocalStorage:(CRIMMessageInfo *)message
recvID:(NSString *)recvID
sendID:(NSString *)sendID
onSuccess:(nullable CRIMMessageInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | CRIMMessageInfo | 是 | 消息体 |
| recvID | NSString | 是 | 接收用户ID |
| sendID | NSString | 是 | 发送者ID |
| onSuccess | CRIMMessageInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
插入一条群聊消息到本地
- (void)insertGrpMsgToLocalStorage:(CRIMMessageInfo *)message
groupID:(NSString * _Nullable)groupID
sendID:(NSString * _Nullable)sendID
onSuccess:(nullable CRIMMessageInfoCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | CRIMMessageInfo | 是 | 消息体 |
| groupID | NSString | 否 | 群ID |
| sendID | NSString | 否 | 发送者ID |
| onSuccess | CRIMMessageInfoCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
相关回调请参考:
查找本地消息
- (void)searchLocalMsgs:(CRIMSearchParam *)param
onSuccess:(nullable CRIMMessageSearchCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| message | CRIMSearchParam | 是 | 搜索消息体 |
| onSuccess | CRIMMessageSearchCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
独立上传文件到初始化sdk的objectStorage
发送多媒体消息不需调用此函数,其在sdk内部自动上传
- (void)uploadFile:(NSString *)fullPath
name:(NSString * _Nullable)name
cause:(NSString * _Nullable)cause
onProgress:(CRIMUploadProgressCallback)onProgress
onSuccess:(CRIMSuccessCallback)onSuccess
onFailure:(CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| fullPath | NSString | 是 | 文件在本机的完整路径 |
| name | NSString | 否 | 文件名字 |
| cause | NSString | 否 | 文件分类 |
| onProgress | CRIMUploadProgressCallback | 否 | 上传进度回调 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
全局设置消息提示
- (void)setGlobalRecvMsgOpt:(CRIMReceiveMessageOpt)opt
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| opt | CRIMReceiveMessageOpt | 是 | 提示类型 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
获取历史消息
从最新一条消息开始获取会话中的历史聊天记录。
- (void)getAdvancedHistoryMsgList:(CRIMGetAdvancedHistoryMessageListParam *)opts
onSuccess:(nullable CRIMGetAdvancedHistoryMessageListCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| opts | CRIMGetAdvancedHistoryMessageListParam | 是 | 历史消息查询实例 |
| onSuccess | CRIMGetAdvancedHistoryMessageListCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
反向获取历史消息
反向获取会话中的历史聊天记录,可用于定位消息上下文时后向下拉取历史消息。
- (void)getAdvancedHistoryMsgListReverse:(CRIMGetAdvancedHistoryMessageListParam *)opts
onSuccess:(nullable CRIMGetAdvancedHistoryMessageListCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| opts | CRIMGetAdvancedHistoryMessageListParam | 是 | 历史消息查询实例 |
| onSuccess | CRIMGetAdvancedHistoryMessageListCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |
设置角标
告知服务器 客户端现有的数量
- (void)setAppBadge:(NSInteger)count
onSuccess:(nullable CRIMSuccessCallback)onSuccess
onFailure:(nullable CRIMFailureCallback)onFailure;
-
返回值:无
-
参数:
| 参数 | 类型 | 必传 | 含义 |
|---|---|---|---|
| count | NSInteger | 是 | 角标数 |
| onSuccess | CRIMSuccessCallback | 否 | 操作成功的回调 |
| onFailure | CRIMFailureCallback | 否 | 操作失败的回调 |