BMXConversation Class Reference

Inherits from BMXBaseObject :
NSObject
Declared in floo_proxy.h

Overview

@interface Conversation

Instance Methods

conversationId

Conversation ID

- (long long)conversationId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

dealloc

- (void)dealloc

Example:

editMessage

Edit a message

- (NSString *)editMessage

Return Value

NSString

Declared In

  • floo_proxy.h

Example:

extension

Extension information of a message

- (NSString *)extension

Return Value

NSString

Declared In

  • floo_proxy.h

Example:

insertMessageWithMsg:

Insert a message

- (BMXErrorCode)insertMessageWithMsg:(BMXMessage *)*msg*

Parameters

msg
The message

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

insertMessageWithMsg:completion:

Insert a message

- (void)insertMessageWithMsg:(BMXMessage *)*msg* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Parameters

msg
The message

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

isMuteNotification

Turn off message notifications

- (BOOL)isMuteNotification

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

lastMsg

The last message

- (BMXMessage *)lastMsg

Return Value

BMXMessage

Declared In

  • floo_proxy.h

Example:

loadMessageWithMsgId:

Get a message by ID

- (BMXMessage *)loadMessageWithMsgId:(long long)*msgId*

Parameters

msgId
The message ID

Return Value

BMXMessage

Declared In

  • floo_proxy.h

Example:

loadMessageWithMsgId:completion:

Get a message by ID

- (void)loadMessageWithMsgId:(long long)*msgId* completion:(void ( ^ ) ( BMXMessage *res , BMXError *aError ))*resBlock*

Parameters

msgId
The message ID

Return Value

BMXMessage

Declared In

  • floo_proxy.h

Example:

loadMessagesWithRefMsgId:size:arg4:completion:

Get messages from the starting message ID

- (void)loadMessagesWithRefMsgId:(long long)*refMsgId* size:(unsigned long)*size* arg4:(BMXConversation_Direction)*arg4* completion:(void ( ^ ) ( BMXMessageList *result , BMXError *aError ))*resBlock*

Parameters

refMsgId
Starting message ID

size
Maximum number of messages

result
Message list as result

Direction
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

loadMessagesWithRefMsgId:size:completion:

Search messages by message ID

- (void)loadMessagesWithRefMsgId:(long long)*refMsgId* size:(unsigned long)*size* completion:(void ( ^ ) ( BMXMessageList *result , BMXError *aError ))*resBlock*

Parameters

size
Maximum number of messages

refTime
Starting time

result
Message list as result

keywords
The keywords

Direction
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

loadMessagesWithRefMsgId:size:result:

- (BMXErrorCode)loadMessagesWithRefMsgId:(long long)*refMsgId* size:(unsigned long)*size* result:(BMXMessageList *)*result*

Example:

loadMessagesWithRefMsgId:size:result:arg4:

Load messages

- (BMXErrorCode)loadMessagesWithRefMsgId:(long long)*refMsgId* size:(unsigned long)*size* result:(BMXMessageList *)*result* arg4:(BMXConversation_Direction)*arg4*

Parameters

refMsgId
First Message Id

size
Maximum number of messages

result
Message list as result

Direction
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

messageCount

The number of messages

- (int)messageCount

Return Value

int

Declared In

  • floo_proxy.h

Example:

refreshConversation

Force update the total number of messages and unread messages for the conversation

- (BMXErrorCode)refreshConversation

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

refreshConversationWithCompletion:

Force update the total number of messages and unread messages for the conversation

- (void)refreshConversationWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

removeAllMessages

Remove all messages in the conversation

- (BMXErrorCode)removeAllMessages

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

removeAllMessagesWithCompletion:

Remove all messages in the conversation

- (void)removeAllMessagesWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

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 ( ^ ) ( BMXMessageList *result , 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

BMXErrorCode

Discussion

Deprecated. use searchMessagesByKeyWords instead.

Declared In

  • floo_proxy.h

Example:

searchMessagesByKeyWordsWithKeywords:refTime:size:completion:

- (void)searchMessagesByKeyWordsWithKeywords:(NSString *)*keywords* refTime:(long long)*refTime* size:(unsigned long)*size* completion:(void ( ^ ) ( BMXMessageList *result , BMXError *aError ))*resBlock*

Example:

searchMessagesByKeyWordsWithKeywords:refTime:size:result:

- (BMXErrorCode)searchMessagesByKeyWordsWithKeywords:(NSString *)*keywords* refTime:(long long)*refTime* size:(unsigned long)*size* result:(BMXMessageList *)*result*

Example:

searchMessagesByKeyWordsWithKeywords:refTime:size:result:arg5:

Search messages by keywords

- (BMXErrorCode)searchMessagesByKeyWordsWithKeywords:(NSString *)*keywords* refTime:(long long)*refTime* size:(unsigned long)*size* result:(BMXMessageList *)*result* arg5:(BMXConversation_Direction)*arg5*

Parameters

keywords
The keywords

refTime
Starting time

size
Maximum number of messages

result
Message list as result

arg5
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

searchMessagesByTypeWithType:refTime:size:arg5:completion:

Search messages by type

- (void)searchMessagesByTypeWithType:(BMXMessage_ContentType)*type* refTime:(long long)*refTime* size:(unsigned long)*size* arg5:(BMXConversation_Direction)*arg5* completion:(void ( ^ ) ( BMXMessageList *result , BMXError *aError ))*resBlock*

Parameters

type
The type

refTime
Starting time

size
Maximum number of messages

result
Message list as result

Direction
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

searchMessagesByTypeWithType:refTime:size:completion:

- (void)searchMessagesByTypeWithType:(BMXMessage_ContentType)*type* refTime:(long long)*refTime* size:(unsigned long)*size* completion:(void ( ^ ) ( BMXMessageList *result , BMXError *aError ))*resBlock*

Example:

searchMessagesByTypeWithType:refTime:size:result:

- (BMXErrorCode)searchMessagesByTypeWithType:(BMXMessage_ContentType)*type* refTime:(long long)*refTime* size:(unsigned long)*size* result:(BMXMessageList *)*result*

Example:

searchMessagesByTypeWithType:refTime:size:result:arg5:

Search messages by type

- (BMXErrorCode)searchMessagesByTypeWithType:(BMXMessage_ContentType)*type* refTime:(long long)*refTime* size:(unsigned long)*size* result:(BMXMessageList *)*result* arg5:(BMXConversation_Direction)*arg5*

Parameters

type
The type

refTime
Starting time

size
Maximum number of messages

result
Message list as result

Direction
Search direction, Up for earlier

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setAllMessagesRead

Set all messages as read

- (BMXErrorCode)setAllMessagesRead

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setAllMessagesReadWithCompletion:

Set all messages as read

- (void)setAllMessagesReadWithCompletion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setEditMessage:

Set message in editting

- (BMXErrorCode)setEditMessage:(NSString *)*editMessage*

Parameters

editMessage
The message content

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setExtension:

Set extension information of messages

- (BMXErrorCode)setExtension:(NSString *)*ext*

Parameters

ext
The extension information

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setMessagePlayedStatus:status:

Set palyed status of messages

- (BMXErrorCode)setMessagePlayedStatus:(BMXMessage *)*msg* status:(BOOL)*status*

Parameters

msg
The message

status
Played or not

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setMessagePlayedStatus:status:completion:

Set the palyed status of messages

- (void)setMessagePlayedStatus:(BMXMessage *)*msg* status:(BOOL)*status* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Parameters

msg
The message

status
Played or not

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setMessageReadStatus:status:

Set the read status of messages

- (BMXErrorCode)setMessageReadStatus:(BMXMessage *)*msg* status:(BOOL)*status*

Parameters

msg
The message

status
Read or not

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

setMessageReadStatus:status:completion:

Set the read status of messages

- (void)setMessageReadStatus:(BMXMessage *)*msg* status:(BOOL)*status* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Parameters

msg
The message

status
Read or not

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

type

Conversation type

- (BMXConversation_Type)type

Return Value

BMXConversation_Type

Declared In

  • floo_proxy.h

Example:

unreadNumber

THe number of unread messages

- (int)unreadNumber

Return Value

int

Declared In

  • floo_proxy.h

Example:

updateMessageExtensionWithMsg:

Update the extension information of a message

- (BMXErrorCode)updateMessageExtensionWithMsg:(BMXMessage *)*msg*

Parameters

msg
The message

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

updateMessageExtensionWithMsg:completion:

Update the extension information of a message

- (void)updateMessageExtensionWithMsg:(BMXMessage *)*msg* completion:(void ( ^ ) ( BMXError *aError ))*resBlock*

Parameters

msg
The message

Return Value

BMXErrorCode

Declared In

  • floo_proxy.h

Example:

© 2019-2024 MaximTop | Homepage | Site Map Last modified time: 2024-12-07 06:49:06