NIMSDK-iOS
载入中...
搜索中...
未找到
构造函数 | 所有成员列表
<NIMChatExtendManager>协议 参考

#import <NIMChatExtendManagerProtocol.h>

类 <NIMChatExtendManager> 继承关系图:

构造函数

(BOOL) - reply:to:error:
 
(void) - reply:to:completion:
 
(NSArray< NIMMessage * > *_Nullable) - subMessages:
 
(NSInteger) - subMessagesCount:
 
(void) - fetchSubMessages:option:completion:
 
(void) - fetchSubMessagesFrom:option:completion:
 
(void) - fetchHistoryMessages:syncToDB:completion:
 
(void) - addQuickComment:toMessage:completion:
 
(void) - deleteQuickComment:completion:
 
(void) - fetchQuickComments:completion:
 
(void) - quickCommentsByMessage:completion:
 
(void) - queryCollect:completion:
 
(void) - addCollect:completion:
 
(void) - removeCollect:completion:
 
(void) - updateCollect:completion:
 
(void) - addStickTopSession:completion:
 
(void) - removeStickTopSession:completion:
 
(void) - udpateStickTopSession:completion:
 
(void) - loadStickTopSessionInfos:
 
(void) - loadRecentSessionsWithOptions:completion:
 
(NSArray< NIMRecentSession * > *) - sortRecentSessions:withStickTopInfos:
 
(NIMStickTopSessionInfo *) - stickTopInfoForSession:
 
(void) - addMessagePin:completion:
 
(void) - removeMessagePin:completion:
 
(void) - updateMessagePin:completion:
 
(void) - loadMessagePinsForSession:completion:
 
(NIMMessagePinItem *) - pinItemForMessage:
 
(void) - addDelegate:
 
(void) - removeDelegate:
 

详细描述

聊天扩展

函数文档

◆ addCollect:completion:

- (void) addCollect: (NIMAddCollectParams *)  info
completion: (nullable NIMAddCollectBlock)  completion 

添加一个收藏

参数
info添加收藏的参数，必须字段：type、data、ext
completion添加完成的回调

◆ addDelegate:

- (void) addDelegate: (id< NIMChatExtendManagerDelegate >)  delegate

添加Thread Talk委托

参数
delegate聊天委托

◆ addMessagePin:completion:

- (void) addMessagePin: (NIMMessagePinItem *)  item
completion: (nullable NIMAddMessagePinCompletion)  completion 

添加一条PIN记录

参数
item需要添加的PIN记录
completion添加完成的回调

◆ addQuickComment:toMessage:completion:

- (void) addQuickComment: (NIMQuickComment *)  comment
toMessage: (NIMMessage *)  message
completion: (NIMQuickCommentHandler _Nullable)  completion 

发送快捷回复

参数
comment回复内容
message被回复消息
completion完成回调

◆ addStickTopSession:completion:

- (void) addStickTopSession: (NIMAddStickTopSessionParams *)  params
completion: (nullable NIMAddStickTopSessionCompletion)  completion 

添加一条置顶记录

参数
params添加置顶的参数
completion添加置顶记录完成的回调

◆ deleteQuickComment:completion:

- (void) deleteQuickComment: (NIMQuickComment *)  comment
completion: (NIMQuickCommentHandler _Nullable)  completion 

从服务端删除一条评论

参数
comment目标评论
completion完成回调

◆ fetchHistoryMessages:syncToDB:completion:

- (void) fetchHistoryMessages: (NSArray< NIMChatExtendBasicInfo * > *)  infos
syncToDB: (BOOL)  sync
completion: (NIMFetchHistoryMessagesByIds)  block 

根据MessageId等获取消息

参数
infos请求信息
sync是否同步到本地，注:DB标记状态删除的消息无法被同步覆盖
block完成回调

◆ fetchQuickComments:completion:

- (void) fetchQuickComments: (NSArray< NIMMessage * > *)  messages
completion: (NIMFetchCommentsByMsgsHandler)  completion 

批量获取快捷评论

参数
messages目标消息, 最多批量20个
completion完成回调

◆ fetchSubMessages:option:completion:

- (void) fetchSubMessages: (NIMChatExtendBasicInfo *)  info
option: (NIMThreadTalkFetchOption *_Nullable)  option
completion: (NIMThreadTalkFetchMessages)  block 

获取指定消息的Thread Talk子消息

参数
info目标消息
option查询分页选项
block完成回调

◆ fetchSubMessagesFrom:option:completion:

- (void) fetchSubMessagesFrom: (NIMMessage *)  message
option: (NIMThreadTalkFetchOption *_Nullable)  option
completion: (NIMThreadTalkFetchMessages)  block 

获取指定消息的Thread Talk子消息

参数
message目标消息
option查询分页选项
block完成回调

◆ loadMessagePinsForSession:completion:

- (void) loadMessagePinsForSession: (NIMSession *)  session
completion: (nullable NIMLoadMessagePinsCompletion)  completion 

查询全部PIN记录(登录后首次查询该会话会触发一次网络同步)

参数
session会话
completion加载完成的回调

◆ loadRecentSessionsWithOptions:completion:

- (void) loadRecentSessionsWithOptions: (NIMLoadRecentSessionsOptions *)  options
completion: (nullable NIMLoadRecentSessionsCompletion)  completion 

获取最近会话列表

参数
options查询选项（如按照置顶会话排序）

◆ loadStickTopSessionInfos:

- (void) loadStickTopSessionInfos: (nullable NIMLoadStickTopSessionInfosCompletion)  completion

查找所有的置顶记录

参数
completion查找完成的回调

◆ pinItemForMessage:

- (NIMMessagePinItem *) pinItemForMessage: (NIMMessage *)  message

查询某条消息的PIN记录

参数
message消息
返回
记录

◆ queryCollect:completion:

- (void) queryCollect: (NIMCollectQueryOptions *)  option
completion: (nullable NIMCollectQueryBlock)  completion 

分页查询收藏列表

参数
option分页查询选项
completion查询完成的回调

◆ quickCommentsByMessage:completion:

- (void) quickCommentsByMessage: (NIMMessage *)  message
completion: (NIMGetQuickCommentsByMsgHandler)  completion 

本地获取消息对应的快捷评论结果

参数
message目标消息
completion完成回调

◆ removeCollect:completion:

- (void) removeCollect: (NSArray< NIMCollectInfo * > *)  collectList
completion: (nullable NIMRemoveCollectBlock)  completion 

批量移除收藏

参数
collectList批量移除的收藏对象，必须字段：id、createTime
completion移除完成的回调

◆ removeDelegate:

- (void) removeDelegate: (id< NIMChatExtendManagerDelegate >)  delegate

移除Thread Talk委托

参数
delegate聊天委托

◆ removeMessagePin:completion:

- (void) removeMessagePin: (NIMMessagePinItem *)  item
completion: (nullable NIMRemoveMessagePinCompletion)  completion 

删除一条PIN记录

参数
item需要删除的PIN记录
completion删除完成的回调

◆ removeStickTopSession:completion:

- (void) removeStickTopSession: (NIMStickTopSessionInfo *)  info
completion: (nullable NIMRemoveStickTopSessionCompletion)  completion 

删除一条置顶记录

参数
info需要删除的置顶记录
completion删除完成的回调

◆ reply:to:completion:

- (void) reply: (NIMMessage *)  message
to: (NIMMessage *)  target
completion: (__nullable NIMChatManagerBlock)  block 

异步回复消息

参数
message新生成的消息
target被回复的消息
block发送完成后的回调，这里的回调完成只表示当前这个函数调用完成，需要后续的回调才能判断消息是否已经发送至服务器

◆ reply:to:error:

- (BOOL) reply: (NIMMessage *)  message
to: (NIMMessage *)  target
error: (NSError *__nullable *)  error 

回复消息

参数
message新生成的消息
target被回复的消息
error错误 如果在准备发送消息阶段发生错误,这个error会被填充相应的信息
返回
是否调用成功,这里返回的 result 只是表示当前这个函数调用是否成功,需要后续的回调才能够判断消息是否已经发送至服务器

◆ sortRecentSessions:withStickTopInfos:

- (NSArray< NIMRecentSession * > *) sortRecentSessions: (NSArray< NIMRecentSession * > *)  recentSessions
withStickTopInfos: (NSDictionary< NIMSession *, NIMStickTopSessionInfo * > *)  infos 

根据置顶信息排序最近会话

参数
recentSessions需要排序的置顶会话，若传可变数组则进行in place排序
infos[会话：置顶信息] 映射
返回
排序后的最近会话列表，若传如可变数组，则返回其数组本身

◆ stickTopInfoForSession:

- (NIMStickTopSessionInfo *) stickTopInfoForSession: (NIMSession *)  session

查询某个会话的置顶信息

参数
session需要查询的会话
返回
置顶信息

◆ subMessages:

- (NSArray< NIMMessage * > *_Nullable) subMessages: (NIMMessage *)  message

本地获取Thread Talk的消息列表

参数
message父消息
返回
目标message的子消息列表

◆ subMessagesCount:

- (NSInteger) subMessagesCount: (NIMMessage *)  message

本地获取Thread Talk的消息列表

参数
message父消息
返回
目标message的子消息数目

◆ udpateStickTopSession:completion:

- (void) udpateStickTopSession: (NIMStickTopSessionInfo *)  info
completion: (nullable NIMUpdateStickTopSessionCompletion)  completion 

更新一条置顶记录的扩展信息

参数
info需要更新的置顶记录
completion删除完成的回调

◆ updateCollect:completion:

- (void) updateCollect: (NIMCollectInfo *)  collectInfo
completion: (nullable NIMUpdateCollectBlock)  completion 

更新收藏ext

参数
collectInfo需要更新的收藏对象，需要id、createTime、ext字段，如果ext不传，表示删除ext字段

◆ updateMessagePin:completion:

- (void) updateMessagePin: (NIMMessagePinItem *)  item
completion: (nullable NIMUpdateMessagePinCompletion)  completion 

更新一条PIN记录的扩展字段(ext)

参数
item需要更新的PIN记录，ext不传为删除
completion更新完成的回调
该协议的文档由以下文件生成: