NIMSDK-iOS
|
#import <NIMChatExtendManagerProtocol.h>
聊天扩展
- (void) addCollect: | (NIMAddCollectParams *) | info | |
completion: | (nullable NIMAddCollectBlock) | completion | |
添加一个收藏
info | 添加收藏的参数,必须字段:type、data、ext |
completion | 添加完成的回调 |
- (void) addDelegate: | (id< NIMChatExtendManagerDelegate >) | delegate |
添加Thread Talk委托
delegate | 聊天委托 |
- (void) addMessagePin: | (NIMMessagePinItem *) | item | |
completion: | (nullable NIMAddMessagePinCompletion) | completion | |
添加一条PIN记录
item | 需要添加的PIN记录 |
completion | 添加完成的回调 |
- (void) addQuickComment: | (NIMQuickComment *) | comment | |
toMessage: | (NIMMessage *) | message | |
completion: | (NIMQuickCommentHandler _Nullable) | completion | |
发送快捷回复
comment | 回复内容 |
message | 被回复消息 |
completion | 完成回调 |
- (void) addStickTopSession: | (NIMAddStickTopSessionParams *) | params | |
completion: | (nullable NIMAddStickTopSessionCompletion) | completion | |
添加一条置顶记录
params | 添加置顶的参数 |
completion | 添加置顶记录完成的回调 |
- (void) deleteQuickComment: | (NIMQuickComment *) | comment | |
completion: | (NIMQuickCommentHandler _Nullable) | completion | |
从服务端删除一条评论
comment | 目标评论 |
completion | 完成回调 |
- (void) fetchHistoryMessages: | (NSArray< NIMChatExtendBasicInfo * > *) | infos | |
syncToDB: | (BOOL) | sync | |
completion: | (NIMFetchHistoryMessagesByIds) | block | |
根据MessageId等获取消息
infos | 请求信息 |
sync | 是否同步到本地,注:DB标记状态删除的消息无法被同步覆盖 |
block | 完成回调 |
- (void) fetchQuickComments: | (NSArray< NIMMessage * > *) | messages | |
completion: | (NIMFetchCommentsByMsgsHandler) | completion | |
批量获取快捷评论
messages | 目标消息, 最多批量20个 |
completion | 完成回调 |
- (void) fetchSubMessages: | (NIMChatExtendBasicInfo *) | info | |
option: | (NIMThreadTalkFetchOption *_Nullable) | option | |
completion: | (NIMThreadTalkFetchMessages) | block | |
获取指定消息的Thread Talk子消息
info | 目标消息 |
option | 查询分页选项 |
block | 完成回调 |
- (void) fetchSubMessagesFrom: | (NIMMessage *) | message | |
option: | (NIMThreadTalkFetchOption *_Nullable) | option | |
completion: | (NIMThreadTalkFetchMessages) | block | |
获取指定消息的Thread Talk子消息
message | 目标消息 |
option | 查询分页选项 |
block | 完成回调 |
- (void) loadMessagePinsForSession: | (NIMSession *) | session | |
completion: | (nullable NIMLoadMessagePinsCompletion) | completion | |
查询全部PIN记录(登录后首次查询该会话会触发一次网络同步)
session | 会话 |
completion | 加载完成的回调 |
- (void) loadRecentSessionsWithOptions: | (NIMLoadRecentSessionsOptions *) | options | |
completion: | (nullable NIMLoadRecentSessionsCompletion) | completion | |
获取最近会话列表
options | 查询选项(如按照置顶会话排序) |
- (void) loadStickTopSessionInfos: | (nullable NIMLoadStickTopSessionInfosCompletion) | completion |
查找所有的置顶记录
completion | 查找完成的回调 |
- (NIMMessagePinItem *) pinItemForMessage: | (NIMMessage *) | message |
查询某条消息的PIN记录
message | 消息 |
- (void) queryCollect: | (NIMCollectQueryOptions *) | option | |
completion: | (nullable NIMCollectQueryBlock) | completion | |
分页查询收藏列表
option | 分页查询选项 |
completion | 查询完成的回调 |
- (void) quickCommentsByMessage: | (NIMMessage *) | message | |
completion: | (NIMGetQuickCommentsByMsgHandler) | completion | |
本地获取消息对应的快捷评论结果
message | 目标消息 |
completion | 完成回调 |
- (void) removeCollect: | (NSArray< NIMCollectInfo * > *) | collectList | |
completion: | (nullable NIMRemoveCollectBlock) | completion | |
批量移除收藏
collectList | 批量移除的收藏对象,必须字段:id、createTime |
completion | 移除完成的回调 |
- (void) removeDelegate: | (id< NIMChatExtendManagerDelegate >) | delegate |
移除Thread Talk委托
delegate | 聊天委托 |
- (void) removeMessagePin: | (NIMMessagePinItem *) | item | |
completion: | (nullable NIMRemoveMessagePinCompletion) | completion | |
删除一条PIN记录
item | 需要删除的PIN记录 |
completion | 删除完成的回调 |
- (void) removeStickTopSession: | (NIMStickTopSessionInfo *) | info | |
completion: | (nullable NIMRemoveStickTopSessionCompletion) | completion | |
删除一条置顶记录
info | 需要删除的置顶记录 |
completion | 删除完成的回调 |
- (void) reply: | (NIMMessage *) | message | |
to: | (NIMMessage *) | target | |
completion: | (__nullable NIMChatManagerBlock) | block | |
异步回复消息
message | 新生成的消息 |
target | 被回复的消息 |
block | 发送完成后的回调,这里的回调完成只表示当前这个函数调用完成,需要后续的回调才能判断消息是否已经发送至服务器 |
- (BOOL) reply: | (NIMMessage *) | message | |
to: | (NIMMessage *) | target | |
error: | (NSError *__nullable *) | error | |
回复消息
message | 新生成的消息 |
target | 被回复的消息 |
error | 错误 如果在准备发送消息阶段发生错误,这个error会被填充相应的信息 |
- (NSArray< NIMRecentSession * > *) sortRecentSessions: | (NSArray< NIMRecentSession * > *) | recentSessions | |
withStickTopInfos: | (NSDictionary< NIMSession *, NIMStickTopSessionInfo * > *) | infos | |
根据置顶信息排序最近会话
recentSessions | 需要排序的置顶会话,若传可变数组则进行in place排序 |
infos | [会话:置顶信息] 映射 |
- (NIMStickTopSessionInfo *) stickTopInfoForSession: | (NIMSession *) | session |
查询某个会话的置顶信息
session | 需要查询的会话 |
- (NSArray< NIMMessage * > *_Nullable) subMessages: | (NIMMessage *) | message |
本地获取Thread Talk的消息列表
message | 父消息 |
- (NSInteger) subMessagesCount: | (NIMMessage *) | message |
本地获取Thread Talk的消息列表
message | 父消息 |
- (void) udpateStickTopSession: | (NIMStickTopSessionInfo *) | info | |
completion: | (nullable NIMUpdateStickTopSessionCompletion) | completion | |
更新一条置顶记录的扩展信息
info | 需要更新的置顶记录 |
completion | 删除完成的回调 |
- (void) updateCollect: | (NIMCollectInfo *) | collectInfo | |
completion: | (nullable NIMUpdateCollectBlock) | completion | |
更新收藏ext
collectInfo | 需要更新的收藏对象,需要id、createTime、ext字段,如果ext不传,表示删除ext字段 |
- (void) updateMessagePin: | (NIMMessagePinItem *) | item | |
completion: | (nullable NIMUpdateMessagePinCompletion) | completion | |
更新一条PIN记录的扩展字段(ext)
item | 需要更新的PIN记录,ext不传为删除 |
completion | 更新完成的回调 |