BMXChatService Class Reference#
Inherits from NSObject
Declared in floo_proxy.h
Overview#
@interface 聊天Service
Properties#
swigCMemOwn#
@property (nonatomic) BOOL swigCMemOwn
swigCPtr#
@property (nonatomic) void *swigCPtr
Instance Methods#
ackMessageDeliveredWithMsg:#
发送送达回执
- (void)ackMessageDeliveredWithMsg:(BMXMessage )msg*
Discussion#
发送送达回执
Declared In#
floo_proxy.h
ackMessageDeliveredWithMsg:completion:#
发送送达回执
- (void)ackMessageDeliveredWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Discussion#
发送送达回执
Declared In#
floo_proxy.h
ackMessageWithMsg:#
发送已读回执
- (void)ackMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
需要发送已读回执的消息
Declared In#
floo_proxy.h
ackMessageWithMsg:completion:#
发送已读回执
- (void)ackMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要发送已读回执的消息
Declared In#
floo_proxy.h
ackPlayMessageWithMsg:#
发送音频/视频消息已播放回执
- (void)ackPlayMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
需要发送已读回执的消息
Declared In#
floo_proxy.h
ackPlayMessageWithMsg:completion:#
发送音频/视频消息已播放回执
- (void)ackPlayMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要发送已读回执的消息
Declared In#
floo_proxy.h
addChatListener:#
添加聊天监听者
- (void)addChatListener:(id<BMXChatServiceProtocol>)listener
Discussion#
添加聊天监听者
Declared In#
floo_proxy.h
addDelegate:#
- (void)addDelegate:(id<BMXChatServiceProtocol>)aDelegate
addDelegate:delegateQueue:#
- (void)addDelegate:(id<BMXChatServiceProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue
attachmentDir#
获取附件保存路径
- (NSString *)attachmentDir
Return Value#
NSString
Declared In#
floo_proxy.h
attachmentDirForConversationWithConversationId:#
获取会话的附件保存路径
- (NSString )attachmentDirForConversationWithConversationId:(long long)conversationId*
Parameters#
conversationId
需要获取会话附件路径的会话id
Return Value#
NSString
Declared In#
floo_proxy.h
cancelDownloadAttachmentWithMsg:#
取消下载附件
- (void)cancelDownloadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
需要取消下载附件的消息
Declared In#
floo_proxy.h
cancelDownloadAttachmentWithMsg:completion:#
取消下载附件
- (void)cancelDownloadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要取消下载附件的消息
Declared In#
floo_proxy.h
cancelUploadAttachmentWithMsg:#
取消上传附件
- (void)cancelUploadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
需要取消上传附件的消息
Declared In#
floo_proxy.h
cancelUploadAttachmentWithMsg:completion:#
取消上传附件
- (void)cancelUploadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要取消上传附件的消息
Declared In#
floo_proxy.h
dealloc#
- (void)dealloc
deleteConversationWithConversationId:#
- (void)deleteConversationWithConversationId:(long long)conversationId
deleteConversationWithConversationId:completion:#
- (void)deleteConversationWithConversationId:(long long)conversationId completion:(void ( ^ ) ( BMXError aError ))resBlock*
deleteConversationWithConversationId:synchronize:#
删除会话
- (void)deleteConversationWithConversationId:(long long)conversationId synchronize:(BOOL)synchronize
Parameters#
conversationId
需要删除会话的会话id
synchronize
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Declared In#
floo_proxy.h
deleteConversationWithConversationId:synchronize:completion:#
删除会话
- (void)deleteConversationWithConversationId:(long long)conversationId synchronize:(BOOL)synchronize completion:(void ( ^ ) ( BMXError aError ))resBlock*
Parameters#
conversationId
需要删除会话的会话id
synchronize
是否同步删除其它设备该会话，默认为false，仅删除本设备会话
Declared In#
floo_proxy.h
downloadAttachmentByUrlWithMsgId:url:path:#
下载附件，下载状态变化和进度通过listener通知
- (void)downloadAttachmentByUrlWithMsgId:(long long)msgId url:(NSString )url path:(NSString )path
Discussion#
下载附件，下载状态变化和进度通过listener通知
Declared In#
floo_proxy.h
downloadAttachmentByUrlWithMsgId:url:path:completion:#
下载附件，下载状态变化和进度通过listener通知
- (void)downloadAttachmentByUrlWithMsgId:(long long)msgId url:(NSString )url path:(NSString )path completion:(void ( ^ ) ( BMXError aError ))resBlock*
Discussion#
下载附件，下载状态变化和进度通过listener通知
Declared In#
floo_proxy.h
downloadAttachmentWithMsg:#
下载附件，下载状态变化和进度通过listener通知
- (void)downloadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
需要下载附件的消息
Declared In#
floo_proxy.h
downloadAttachmentWithMsg:completion:#
下载附件，下载状态变化和进度通过listener通知
- (void)downloadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要下载附件的消息
Declared In#
floo_proxy.h
downloadThumbnailWithMsg:#
- (void)downloadThumbnailWithMsg:(BMXMessage )msg*
downloadThumbnailWithMsg:completion:#
- (void)downloadThumbnailWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
downloadThumbnailWithMsg:strategy:#
下载缩略图，下载状态变化和进度通过listener通知
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
- (void)downloadThumbnailWithMsg:(BMXMessage )msg strategy:(BMXChatService_ThumbnailStrategy)strategy*
Parameters#
msg
需要下载缩略图的消息
strategy
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Declared In#
floo_proxy.h
downloadThumbnailWithMsg:strategy:completion:#
下载缩略图，下载状态变化和进度通过listener通知
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
- (void)downloadThumbnailWithMsg:(BMXMessage )msg strategy:(BMXChatService_ThumbnailStrategy)strategy completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要下载缩略图的消息
strategy
缩略图生成策略，1 - 第三方服务器生成， 2 - 本地服务器生成，默认值是 1。
Declared In#
floo_proxy.h
forwardMessageWithList:to:newMsg:#
合并转发消息
- (BMXErrorCode)forwardMessageWithList:(BMXMessageList )list to:(BMXConversation )to newMsg:(BMXMessage )newMsg*
Parameters#
list
转发的消息列表
to
消息被转发到的会话
newMsg
转发的消息列表合并后生成的新的单条转发消息
Return Value#
Declared In#
floo_proxy.h
forwardMessageWithMsg:#
简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
- (void)forwardMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
转发的消息
Declared In#
floo_proxy.h
forwardMessageWithMsg:completion:#
简单转发消息，用户应当通过BMXMessage::createForwardMessage()先创建转发消息
- (void)forwardMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
转发的消息
Declared In#
floo_proxy.h
getAllConversations#
获取所有会话
- (BMXConversationList *)getAllConversations
Return Value#
Declared In#
floo_proxy.h
getAllConversationsUnreadCount#
获取所有会话的全部未读数（标记为屏蔽的个人和群组的未读数不统计在内）
- (int)getAllConversationsUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
getAllConversationsWithCompletion:#
获取所有会话
- (void)getAllConversationsWithCompletion:(void ( ^ ) ( BMXConversationList res ))resBlock*
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUnreadUserIdList:completion:#
获取发送的群组消息未读用户id列表
- (void)getGroupAckMessageUnreadUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
需要获取未读用户id列表的消息
groupMemberIdList
对该条消息未读的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUnreadUserIdList:groupMemberIdList:#
获取发送的群组消息未读用户id列表
- (BMXErrorCode)getGroupAckMessageUnreadUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
需要获取未读用户id列表的消息
groupMemberIdList
对该条消息未读的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUserIdList:completion:#
获取发送的群组消息已读用户id列表
- (void)getGroupAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
需要获取已读用户id列表的消息
groupMemberIdList
对该条消息已读的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUserIdList:groupMemberIdList:#
获取发送的群组消息已读用户id列表
- (BMXErrorCode)getGroupAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
需要获取已读用户id列表的消息
groupMemberIdList
对该条消息已读的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupPlayAckMessageUserIdList:completion:#
获取发送的群组音频/视频消息已播放用户id列表（仅用于音频/视频消息）
- (void)getGroupPlayAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
需要获取已播放用户id列表的消息
groupMemberIdList
对该条消息已播放的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupPlayAckMessageUserIdList:groupMemberIdList:#
获取发送的群组音频/视频消息已播放用户id列表（仅用于音频/视频消息）
- (BMXErrorCode)getGroupPlayAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
需要获取已播放用户id列表的消息
groupMemberIdList
对该条消息已播放的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupUnPlayAckMessageUserIdList:completion:#
获取发送的群组音频/视频消息未播放用户id列表（仅用于音频/视频消息）
- (void)getGroupUnPlayAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
需要获取未播放用户id列表的消息
groupMemberIdList
对该条消息未播放的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getGroupUnPlayAckMessageUserIdList:groupMemberIdList:#
获取发送的群组音频/视频消息未播放用户id列表（仅用于音频/视频消息）
- (BMXErrorCode)getGroupUnPlayAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
需要获取未播放用户id列表的消息
groupMemberIdList
对该条消息未播放的用户id列表，初始传入为空列表
Return Value#
Declared In#
floo_proxy.h
getMessage:#
读取一条消息
- (BMXMessage )getMessage:(long long)msgId*
Parameters#
msgId
需要获取消息的消息id
Return Value#
Declared In#
floo_proxy.h
initWithCptr:swigOwnCObject:#
- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*
insertMessagesWithList:#
插入消息
- (BMXErrorCode)insertMessagesWithList:(BMXMessageList )list*
Parameters#
list
插入消息列表
Return Value#
Declared In#
floo_proxy.h
insertMessagesWithList:completion:#
插入消息
- (void)insertMessagesWithList:(BMXMessageList )list completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
list
插入消息列表
Return Value#
Declared In#
floo_proxy.h
openConversationWithConversationId:type:#
- (BMXConversation )openConversationWithConversationId:(long long)conversationId type:(BMXConversation_Type)type*
openConversationWithConversationId:type:createIfNotExist:#
打开一个会话
- (BMXConversation )openConversationWithConversationId:(long long)conversationId type:(BMXConversation_Type)type createIfNotExist:(BOOL)createIfNotExist*
Parameters#
conversationId
需要打开的会话的会话id
type
会话的类型，单聊还是群聊。
createIfNotExist
会话不存在的情况下是否要创建本地会话，默认为创建
Return Value#
Declared In#
floo_proxy.h
readAllMessageWithMsg:#
标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
- (void)readAllMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
需要标记为此消息以前全部消息为已读的消息
Declared In#
floo_proxy.h
readAllMessageWithMsg:completion:#
标记此消息及之前全部消息为已读，该消息同步到当前用户的所有设备
- (void)readAllMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要标记为此消息以前全部消息为已读的消息
Declared In#
floo_proxy.h
readCancelWithMsg:#
标记此消息为未读，该消息同步到当前用户的所有设备
- (void)readCancelWithMsg:(BMXMessage )msg*
Parameters#
msg
需要发送消息已读取消的消息
Declared In#
floo_proxy.h
readCancelWithMsg:completion:#
标记此消息为未读，该消息同步到当前用户的所有设备
- (void)readCancelWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要发送消息已读取消的消息
Declared In#
floo_proxy.h
recallMessageWithMsg:#
撤回消息，消息状态变化会通过listener通知
- (void)recallMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
撤回的消息
Declared In#
floo_proxy.h
recallMessageWithMsg:completion:#
撤回消息，消息状态变化会通过listener通知
- (void)recallMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
撤回的消息
Declared In#
floo_proxy.h
removeChatListener:#
移除聊天监听者
- (void)removeChatListener:(id<BMXChatServiceProtocol>)listener
Discussion#
移除聊天监听者
Declared In#
floo_proxy.h
removeDelegate:#
- (void)removeDelegate:(id<BMXChatServiceProtocol>)aDelegate
removeMessageWithMsg:#
- (void)removeMessageWithMsg:(BMXMessage )msg*
removeMessageWithMsg:completion:#
- (void)removeMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
removeMessageWithMsg:synchronize:#
删除此消息，该消息同步到当前用户的其它设备
- (void)removeMessageWithMsg:(BMXMessage )msg synchronize:(BOOL)synchronize*
Parameters#
msg
需要删除的消息
synchronize
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Declared In#
floo_proxy.h
removeMessageWithMsg:synchronize:completion:#
删除此消息，该消息同步到当前用户的其它设备
- (void)removeMessageWithMsg:(BMXMessage )msg synchronize:(BOOL)synchronize completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
需要删除的消息
synchronize
是否同步到其它设备，不同步的情况下只会删除本地存储的该条消息
Declared In#
floo_proxy.h
resendMessageWithMsg:#
重新发送消息，消息状态变化会通过listener通知
- (void)resendMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
重新发送的消息
Declared In#
floo_proxy.h
resendMessageWithMsg:completion:#
重新发送消息，消息状态变化会通过listener通知
- (void)resendMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
重新发送的消息
Declared In#
floo_proxy.h
retrieveHistoryMessagesWithConversation:refMsgId:size:completion:#
拉取历史消息
- (void)retrieveHistoryMessagesWithConversation:(BMXConversation )conversation refMsgId:(long long)refMsgId size:(unsigned long)size completion:(void ( ^ ) ( BMXMessageList res , BMXError aError ))resBlock*
Parameters#
conversation
需要拉取历史消息的会话
refMsgId
拉取会话消息的起始消息Id
size
拉取的最大消息条数
result
拉取操作获取的消息列表，外部初始化传入空列表。
Return Value#
Declared In#
floo_proxy.h
retrieveHistoryMessagesWithConversation:refMsgId:size:result:#
拉取历史消息
- (BMXErrorCode)retrieveHistoryMessagesWithConversation:(BMXConversation )conversation refMsgId:(long long)refMsgId size:(unsigned long)size result:(BMXMessageList )result
Parameters#
conversation
需要拉取历史消息的会话
refMsgId
拉取会话消息的起始消息Id
size
拉取的最大消息条数
result
拉取操作获取的消息列表，外部初始化传入空列表。
Return Value#
Declared In#
floo_proxy.h
searchMessagesByKeyWordsWithKeywords:refTime:size:arg5:completion:#
使用关键字搜索消息
- (void)searchMessagesByKeyWordsWithKeywords:(NSString )keywords refTime:(long long)refTime size:(unsigned long)size arg5:(BMXConversation_Direction)arg5 completion:(void ( ^ ) ( BMXMessageListList res , BMXError aError ))resBlock*
Parameters#
keywords
搜索的关键字
refTime
搜索消息的起始时间
size
搜索的最大消息条数
result
搜索到的消息结果列表，外部初始化传入空列表。
Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Return Value#
Declared In#
floo_proxy.h
searchMessagesByKeyWordsWithKeywords:refTime:size:completion:#
- (void)searchMessagesByKeyWordsWithKeywords:(NSString )keywords refTime:(long long)refTime size:(unsigned long)size completion:(void ( ^ ) ( BMXMessageListList res , BMXError aError ))resBlock*
searchMessagesByKeyWordsWithKeywords:refTime:size:result:#
- (BMXErrorCode)searchMessagesByKeyWordsWithKeywords:(NSString )keywords refTime:(long long)refTime size:(unsigned long)size result:(BMXMessageListList )result
searchMessagesByKeyWordsWithKeywords:refTime:size:result:arg5:#
使用关键字搜索消息
- (BMXErrorCode)searchMessagesByKeyWordsWithKeywords:(NSString )keywords refTime:(long long)refTime size:(unsigned long)size result:(BMXMessageListList )result arg5:(BMXConversation_Direction)arg5
Parameters#
keywords
搜索的关键字
refTime
搜索消息的起始时间
size
搜索的最大消息条数
result
搜索到的消息结果列表，外部初始化传入空列表。
Direction
消息搜索方向，默认（Direction::Up）是从更早的消息中搜索
Return Value#
Declared In#
floo_proxy.h
sendMessageWithMsg:#
发送消息，消息状态变化会通过listener通知
- (void)sendMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
发送的消息
Declared In#
floo_proxy.h
sendMessageWithMsg:completion:#
发送消息，消息状态变化会通过listener通知
- (void)sendMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
发送的消息
Declared In#
floo_proxy.h
transferingNum#
上传或下载中的文件数
- (int)transferingNum
Return Value#
int
Declared In#
floo_proxy.h