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

#import <NIMChatManagerProtocol.h>

类 <NIMChatManager> 继承关系图:

构造函数

(BOOL) - sendMessage:toSession:error:
 
(void) - sendMessage:toSession:completion:
 
(BOOL) - cancelSendingMessage:
 
(BOOL) - resendMessage:error:
 
(NIMMessage *) - makeForwardMessageFromMessage:error:
 
(BOOL) - sendForwardMessage:toSession:error:
 
(BOOL) - forwardMessage:toSession:error:
 
(void) - sendMessageReceipt:completion:
 
(void) - sendTeamMessageReceipts:completion:
 
(void) - refreshTeamMessageReceipts:
 
(void) - queryMessageReceiptDetail:completion:
 
(void) - queryMessageReceiptDetail:accountSet:completion:
 
(nullable NIMTeamMessageReceiptDetail *) - localMessageReceiptDetail:
 
(nullable NIMTeamMessageReceiptDetail *) - localMessageReceiptDetail:accountSet:
 
(void) - revokeMessage:completion:
 
(void) - revokeMessage:apnsContent:apnsPayload:shouldBeCounted:completion:
 
(void) - revokeMessage:option:completion:
 
(BOOL) - fetchMessageAttachment:error:
 
(void) - cancelFetchingMessageAttachment:
 
(BOOL) - messageInTransport:
 
(float) - messageTransportProgress:
 
(void) - addDelegate:
 
(void) - removeDelegate:
 

详细描述

聊天协议

函数文档

◆ addDelegate:

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

添加聊天委托

参数
delegate聊天委托

◆ cancelFetchingMessageAttachment:

- (void) cancelFetchingMessageAttachment: (NIMMessage *)  message

取消收取消息附件

参数
message需要取消收取附件的消息

@discussion 附件包括：图片消息的图片缩略图，视频消息的视频缩略图，音频消息的音频文件，文件消息的文件以及自定义消息中的自定义文件 个人和群组消息。SDK 不会触发任何下载回调

◆ cancelSendingMessage:

- (BOOL) cancelSendingMessage: (NIMMessage *)  message

取消正在发送的消息

参数
message目标消息
返回
是否调用成功

◆ fetchMessageAttachment:error:

- (BOOL) fetchMessageAttachment: (NIMMessage *)  message
error: (NSError *__nullable *)  error 

收取消息附件

参数
message需要收取附件的消息
error错误
返回
是否调用成功 @discussion 附件包括：图片消息的图片缩略图，视频消息的视频缩略图，音频消息的音频文件，文件消息的文件以及自定义消息中的自定义文件 个人和群组消息 SDK 会在收到该消息时自动调用本接口，自动下载除 "文件消息的文件" 外的所有附件内容

◆ forwardMessage:toSession:error:

- (BOOL) forwardMessage: (NIMMessage *)  message
toSession: (NIMSession *)  session
error: (NSError *__nullable *)  error 

转发消息

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

◆ localMessageReceiptDetail:

- (nullable NIMTeamMessageReceiptDetail *) localMessageReceiptDetail: (NIMMessage *)  message

从本地数据库查询单条群组消息已读、未读账号列表 注意！！！：这里获取的数据通常比离线前的列表信息更陈旧

参数
message待查询的消息
返回
该消息的已读、未读账号列表

◆ localMessageReceiptDetail:accountSet:

- (nullable NIMTeamMessageReceiptDetail *) localMessageReceiptDetail: (NIMMessage *)  message
accountSet: (NSSet *)  accountSet 

从本地数据库查询单条群组消息在指定用户中的已读、未读账号列表（同步接口） 注意！！！：这里获取的数据通常比离线前的列表信息更陈旧

参数
message待查询的消息
accountSet指定的用户的账号组成的NSSet
返回
该消息的已读、未读账号列表

◆ makeForwardMessageFromMessage:error:

- (NIMMessage *) makeForwardMessageFromMessage: (NIMMessage *)  message
error: (NSError *__autoreleasing _Nullable *_Nullable)  error 

生成转发消息 得到转发消息后，开发者需要自己再调用sendForwardMessage:toSession:error: 进行发送, 和 直接调用forwardMessage:toSession:error:效果一样，但是这样可以得到转发消息的进度方法回调和是否转发成功方法回调

参数
message要转发的消息
error错误 如果在准备发送消息阶段发生错误,这个error会被填充相应的信息
返回
生成的需要转发的消息

◆ messageInTransport:

- (BOOL) messageInTransport: (NIMMessage *)  message

消息是否正在传输 (发送/接受附件)

参数
message消息
返回
是否正在传输

◆ messageTransportProgress:

- (float) messageTransportProgress: (NIMMessage *)  message

传输消息的进度 (发送/接受附件)

参数
message消息
返回
正在传输的消息进度,如果消息不在传输,则返回0

◆ queryMessageReceiptDetail:accountSet:completion:

- (void) queryMessageReceiptDetail: (NIMMessage *)  message
accountSet: (NSSet *)  accountSet
completion: (NIMQueryReceiptDetailBlock)  completion 

查询群组消息指定用户的回执详情

参数
message待查询的消息
accountSet指定的用户的账号组成的NSSet
返回
该消息的已读、未读账号列表

◆ queryMessageReceiptDetail:completion:

- (void) queryMessageReceiptDetail: (NIMMessage *)  message
completion: (NIMQueryReceiptDetailBlock)  completion 

查询群组消息回执详情

参数
message要查询的消息
completion完成后的回调 @discussion 详情包括已读人数的 id 列表和未读人数的 id 列表 查询详情对象不会跟着回执人数变化而变化，如果要获取最新的详情，必须再次调用此接口

◆ refreshTeamMessageReceipts:

- (void) refreshTeamMessageReceipts: (NSArray< NIMMessage * > *)  messages

刷新群组消息已读、未读数量

参数
messages要查询的消息集合 @discussion 消息已读变化后，会通过 NIMChatManager 的代理 onRecvMessageReceipts: 回调给上层 刷新的消息必须为群组消息

◆ removeDelegate:

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

移除聊天委托

参数
delegate聊天委托

◆ resendMessage:error:

- (BOOL) resendMessage: (NIMMessage *)  message
error: (NSError *__nullable *)  error 

重发消息

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

◆ revokeMessage:apnsContent:apnsPayload:shouldBeCounted:completion:

- (void) revokeMessage: (NIMMessage *)  message
apnsContent: (nullable NSString *)  apnsContent
apnsPayload: (nullable NSDictionary *)  apnsPayload
shouldBeCounted: (BOOL)  should
completion: (nullable NIMRevokeMessageBlock)  completion 

撤回消息

参数
message需要被撤回的消息
apnsContent云信推送内容,长度限制500字
apnsPayload云信推送payload信息,长度限制 2K
should是否计入未读数
completion完成回调

◆ revokeMessage:completion:

- (void) revokeMessage: (NIMMessage *)  message
completion: (nullable NIMRevokeMessageBlock)  completion 

撤回消息,不含推送信息

参数
message需要被撤回的消息
completion完成回调 @discussion 消息计入未读数

◆ revokeMessage:option:completion:

- (void) revokeMessage: (NIMMessage *)  message
option: (NIMRevokeMessageOption *)  option
completion: (nullable NIMRevokeMessageBlock)  completion 

撤回消息

参数
message需要被撤回的消息
option撤回的配置选项
completion完成回调 @discussion 消息计入未读数

◆ sendForwardMessage:toSession:error:

- (BOOL) sendForwardMessage: (NIMMessage *)  message
toSession: (NIMSession *)  session
error: (NSError *__nullable *)  error 

发送生成的转发消息

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

◆ sendMessage:toSession:completion:

- (void) sendMessage: (NIMMessage *)  message
toSession: (NIMSession *)  session
completion: (__nullable NIMChatManagerBlock)  completion 

异步发送消息

参数
message消息
session接收方
completion发送完成后的回调，这里的回调完成只表示当前这个函数调用完成，需要后续的回调才能判断消息是否已经发送至服务器

◆ sendMessage:toSession:error:

- (BOOL) sendMessage: (NIMMessage *)  message
toSession: (NIMSession *)  session
error: (NSError *__nullable *)  error 

发送消息

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

◆ sendMessageReceipt:completion:

- (void) sendMessageReceipt: (NIMMessageReceipt *)  receipt
completion: (nullable NIMSendMessageReceiptBlock)  completion 

发送已读回执 (P2P)

参数
receipt已读回执
completion完成回调 @discussion 此接口仅适用于 P2P 消息，群消息已读回执使用 sendTeamMessageReceipts:completion 如果已有比当前已读回执时间戳更大的已读回执已确认，则接口返回成功。

◆ sendTeamMessageReceipts:completion:

- (void) sendTeamMessageReceipts: (NSArray< NIMMessageReceipt * > *)  receipts
completion: (nullable NIMSendTeamMessageReceiptsBlock)  completion 

发送已读回执 (Team 批量接口)

参数
receipts已读回执 receipts count 最多不超过50个
completion完成回调 @discussion 此接口仅适用于 Team 消息。
该协议的文档由以下文件生成: