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