BMXChatService Class Reference#
Inherits from NSObject
Declared in floo_proxy.h
Overview#
@interface Chat Service
Properties#
swigCMemOwn#
@property (nonatomic) BOOL swigCMemOwn
swigCPtr#
@property (nonatomic) void *swigCPtr
Instance Methods#
ackMessageDeliveredWithMsg:#
Send delivery ACK
- (void)ackMessageDeliveredWithMsg:(BMXMessage )msg*
Discussion#
Send delivery ACK
Declared In#
floo_proxy.h
ackMessageDeliveredWithMsg:completion:#
Send delivery ACK
- (void)ackMessageDeliveredWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Discussion#
Send delivery ACK
Declared In#
floo_proxy.h
ackMessageWithMsg:#
Send read ACK
- (void)ackMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
Message to be ACKed
Declared In#
floo_proxy.h
ackMessageWithMsg:completion:#
Send read ACK
- (void)ackMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
Message to be ACKed
Declared In#
floo_proxy.h
ackPlayMessageWithMsg:#
Send played ACK
- (void)ackPlayMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
Message to be ACKed
Declared In#
floo_proxy.h
ackPlayMessageWithMsg:completion:#
Send played ACK
- (void)ackPlayMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
Message to be ACKed
Declared In#
floo_proxy.h
addChatListener:#
Add a chat service listener
- (void)addChatListener:(id<BMXChatServiceProtocol>)listener
Discussion#
Add a chat service listener
Declared In#
floo_proxy.h
addDelegate:#
- (void)addDelegate:(id<BMXChatServiceProtocol>)aDelegate
addDelegate:delegateQueue:#
- (void)addDelegate:(id<BMXChatServiceProtocol>)aDelegate delegateQueue:(dispatch_queue_t)aQueue
attachmentDir#
Get the directory where attachments saved
- (NSString *)attachmentDir
Return Value#
NSString
Declared In#
floo_proxy.h
attachmentDirForConversationWithConversationId:#
Get the directory where attachments saved
- (NSString )attachmentDirForConversationWithConversationId:(long long)conversationId*
Parameters#
conversationId
Conversation ID
Return Value#
NSString
Declared In#
floo_proxy.h
cancelDownloadAttachmentWithMsg:#
Cancel downloading attachments
- (void)cancelDownloadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
cancelDownloadAttachmentWithMsg:completion:#
Cancel downloading attachments
- (void)cancelDownloadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
cancelUploadAttachmentWithMsg:#
Cancel uploading attachments
- (void)cancelUploadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
cancelUploadAttachmentWithMsg:completion:#
Cancel uploading attachments
- (void)cancelUploadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
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:#
Delete conversation
- (void)deleteConversationWithConversationId:(long long)conversationId synchronize:(BOOL)synchronize
Parameters#
conversationId
Conversation ID
synchronize
Whether delete conversations on other devices in the mean time or not, default to false
Declared In#
floo_proxy.h
deleteConversationWithConversationId:synchronize:completion:#
Delete conversation
- (void)deleteConversationWithConversationId:(long long)conversationId synchronize:(BOOL)synchronize completion:(void ( ^ ) ( BMXError aError ))resBlock*
Parameters#
conversationId
Conversation ID
synchronize
Whether delete conversations on other devices in the mean time or not, default to false
Declared In#
floo_proxy.h
downloadAttachmentByUrlWithMsgId:url:path:#
Download attachments, notify changes in download status and progress through the listener
- (void)downloadAttachmentByUrlWithMsgId:(long long)msgId url:(NSString )url path:(NSString )path
Discussion#
Download attachments(Download status and progress callbacked by the listener)
Declared In#
floo_proxy.h
downloadAttachmentByUrlWithMsgId:url:path:completion:#
Download attachments(Download status and progress callbacked by the listener)
- (void)downloadAttachmentByUrlWithMsgId:(long long)msgId url:(NSString )url path:(NSString )path completion:(void ( ^ ) ( BMXError aError ))resBlock*
Discussion#
Download attachments(Download status and progress callbacked by the listener)
Declared In#
floo_proxy.h
downloadAttachmentWithMsg:#
Download attachments(Download status and progress callbacked by the listener)
- (void)downloadAttachmentWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
downloadAttachmentWithMsg:completion:#
Download attachments(Download status and progress callbacked by the listener)
- (void)downloadAttachmentWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
downloadThumbnailWithMsg:#
- (void)downloadThumbnailWithMsg:(BMXMessage )msg*
downloadThumbnailWithMsg:completion:#
- (void)downloadThumbnailWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
downloadThumbnailWithMsg:strategy:#
Download attachments(Download status and progress callbacked by the listener)
Thumbnail generation strategy, 1- generated by third-party servers, 2- generated by local servers, default value is 1
- (void)downloadThumbnailWithMsg:(BMXMessage )msg strategy:(BMXChatService_ThumbnailStrategy)strategy*
Parameters#
msg
The message
strategy
Thumbnail generation strategy, 1- generated by third-party servers, 2- generated by local servers, default value is 1.
Declared In#
floo_proxy.h
downloadThumbnailWithMsg:strategy:completion:#
Download attachments
Thumbnail generation strategy, 1- generated by third-party servers, 2- generated by local servers, default value is 1.
- (void)downloadThumbnailWithMsg:(BMXMessage )msg strategy:(BMXChatService_ThumbnailStrategy)strategy completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
strategy
Thumbnail generation strategy, 1- generated by third-party servers, 2- generated by local servers, default value is 1.
Declared In#
floo_proxy.h
forwardMessageWithList:to:newMsg:#
Merge and forward messages
- (BMXErrorCode)forwardMessageWithList:(BMXMessageList )list to:(BMXConversation )to newMsg:(BMXMessage )newMsg*
Parameters#
list
The message list
to
Destination conversation
newMsg
The new message generated from message list to be forwarded
Return Value#
Declared In#
floo_proxy.h
forwardMessageWithMsg:#
Forward a single message,you should useBMXMessage::createForwardMessage()create the new message first.
- (void)forwardMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
forwardMessageWithMsg:completion:#
Forward a single message,you should useBMXMessage::createForwardMessage()create the new message first.
- (void)forwardMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
getAllConversations#
Get all conversations
- (BMXConversationList *)getAllConversations
Return Value#
Declared In#
floo_proxy.h
getAllConversationsUnreadCount#
Get unread number for all conversations（Exclude blocked users and groups）
- (int)getAllConversationsUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
getAllConversationsWithCompletion:#
Get all conversations
- (void)getAllConversationsWithCompletion:(void ( ^ ) ( BMXConversationList res ))resBlock*
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUnreadUserIdList:completion:#
Get group member ID list who have not read the group message
- (void)getGroupAckMessageUnreadUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUnreadUserIdList:groupMemberIdList:#
Get group member ID list who have not read the group message
- (BMXErrorCode)getGroupAckMessageUnreadUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUserIdList:completion:#
Get group member ID list who have not read the group message
- (void)getGroupAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupAckMessageUserIdList:groupMemberIdList:#
Get group member ID list who read the group message
- (BMXErrorCode)getGroupAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupPlayAckMessageUserIdList:completion:#
Get group member ID list who played the media file in group message
- (void)getGroupPlayAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupPlayAckMessageUserIdList:groupMemberIdList:#
Get group member ID list who played the media file in group message
- (BMXErrorCode)getGroupPlayAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupUnPlayAckMessageUserIdList:completion:#
Get group member ID list who have not played the media file in group message
- (void)getGroupUnPlayAckMessageUserIdList:(BMXMessage )msg completion:(void ( ^ ) ( ListOfLongLong res , BMXError error ))resBlock*
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getGroupUnPlayAckMessageUserIdList:groupMemberIdList:#
Get group member ID list who have not played the media file in group message
- (BMXErrorCode)getGroupUnPlayAckMessageUserIdList:(BMXMessage )msg groupMemberIdList:(ListOfLongLong )groupMemberIdList
Parameters#
msg
The message
groupMemberIdList
Member ID list as result
Return Value#
Declared In#
floo_proxy.h
getMessage:#
Get a message by ID
- (BMXMessage )getMessage:(long long)msgId*
Parameters#
msgId
The message ID
Return Value#
Declared In#
floo_proxy.h
initWithCptr:swigOwnCObject:#
- (id)initWithCptr:(void )cptr swigOwnCObject:(BOOL)ownCObject*
insertMessagesWithList:#
Insert messages
- (BMXErrorCode)insertMessagesWithList:(BMXMessageList )list*
Parameters#
list
The message list
Return Value#
Declared In#
floo_proxy.h
insertMessagesWithList:completion:#
Insert messages
- (void)insertMessagesWithList:(BMXMessageList )list completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
list
The message list
Return Value#
Declared In#
floo_proxy.h
openConversationWithConversationId:type:#
- (BMXConversation )openConversationWithConversationId:(long long)conversationId type:(BMXConversation_Type)type*
openConversationWithConversationId:type:createIfNotExist:#
Open a conversation
- (BMXConversation )openConversationWithConversationId:(long long)conversationId type:(BMXConversation_Type)type createIfNotExist:(BOOL)createIfNotExist*
Parameters#
conversationId
The conversation ID
type
Conversation type: Single or Group
createIfNotExist
Create if NOT exist
Return Value#
Declared In#
floo_proxy.h
readAllMessageWithMsg:#
Mark this message and all previous messages as read and synchronize to all devices of the current user
- (void)readAllMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
readAllMessageWithMsg:completion:#
Mark this message and all previous messages as read and synchronize to all devices of the current user
- (void)readAllMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
readCancelWithMsg:#
Mark this message as unread and synchronize to all devices of the current user
- (void)readCancelWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
readCancelWithMsg:completion:#
Mark this message as unread and synchronize to all devices of the current user
- (void)readCancelWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
recallMessageWithMsg:#
Recall a message
- (void)recallMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
recallMessageWithMsg:completion:#
Recall a message
- (void)recallMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
removeChatListener:#
Remove chat service listener
- (void)removeChatListener:(id<BMXChatServiceProtocol>)listener
Discussion#
Remove chat service listener
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:#
Deletes the message and synchronises the deletion to the current user's other devices
- (void)removeMessageWithMsg:(BMXMessage )msg synchronize:(BOOL)synchronize*
Parameters#
msg
The message
synchronize
Whether or not to synchronize to all devices of the current user
Declared In#
floo_proxy.h
removeMessageWithMsg:synchronize:completion:#
Deletes the message and synchronises the deletion to the current user's other devices
- (void)removeMessageWithMsg:(BMXMessage )msg synchronize:(BOOL)synchronize completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
synchronize
Whether or not to synchronize to all devices of the current user
Declared In#
floo_proxy.h
resendMessageWithMsg:#
Resend a message
- (void)resendMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
The message
Declared In#
floo_proxy.h
resendMessageWithMsg:completion:#
Resend a message
- (void)resendMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
The message
Declared In#
floo_proxy.h
retrieveHistoryMessagesWithConversation:refMsgId:size:completion:#
Message history retrieved
- (void)retrieveHistoryMessagesWithConversation:(BMXConversation )conversation refMsgId:(long long)refMsgId size:(unsigned long)size completion:(void ( ^ ) ( BMXMessageList res , BMXError aError ))resBlock*
Parameters#
conversation
The conversation
refMsgId
First Message Id
size
Maximum number of messages
result
Message list as result
Return Value#
Declared In#
floo_proxy.h
retrieveHistoryMessagesWithConversation:refMsgId:size:result:#
Message history retrieved
- (BMXErrorCode)retrieveHistoryMessagesWithConversation:(BMXConversation )conversation refMsgId:(long long)refMsgId size:(unsigned long)size result:(BMXMessageList )result
Parameters#
conversation
The conversation
refMsgId
First Message Id
size
Maximum number of messages
result
Message list as result
Return Value#
Declared In#
floo_proxy.h
searchMessagesByKeyWordsWithKeywords:refTime:size:arg5:completion:#
Search messages by keywords
- (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
The keywords
refTime
Starting time
size
Maximum number of messages
result
Message list as result
Direction
Search direction, Up for earlier
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:#
Search messages by keywords
- (BMXErrorCode)searchMessagesByKeyWordsWithKeywords:(NSString )keywords refTime:(long long)refTime size:(unsigned long)size result:(BMXMessageListList )result arg5:(BMXConversation_Direction)arg5
Parameters#
keywords
The keywords
refTime
Starting time
size
Maximum number of messages
result
Message list as result
Direction
Search direction, Up for earlier
Return Value#
Declared In#
floo_proxy.h
sendMessageWithMsg:#
Send a message
- (void)sendMessageWithMsg:(BMXMessage )msg*
Parameters#
msg
Message to send
Declared In#
floo_proxy.h
sendMessageWithMsg:completion:#
Send a message
- (void)sendMessageWithMsg:(BMXMessage )msg completion:(void ( ^ ) ( BMXError aError ))resBlock
Parameters#
msg
Message to send
Declared In#
floo_proxy.h
transferingNum#
Number of files in transfer
- (int)transferingNum
Return Value#
int
Declared In#
floo_proxy.h