BMXConversation Class Reference#

Inherits from BMXBaseObject :
NSObject
Declared in floo_proxy.h

Overview#

@interface 會話

Instance Methods#

conversationId#

會話Id

- (long long)conversationId

Return Value#

long long

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="conversationId" %}{% endlanying_code_snippet %}

dealloc#

- (void)dealloc

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="dealloc" %}{% endlanying_code_snippet %}

editMessage#

編輯訊息

- (NSString *)editMessage

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="editMessage" %}{% endlanying_code_snippet %}

extension#

擴展信息

- (NSString *)extension

Return Value#

NSString

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="extension" %}{% endlanying_code_snippet %}

insertMessageWithMsg:#

插入一條訊息

- (BMXErrorCode)insertMessageWithMsg:(BMXMessage )msg*

Parameters#

msg
插入的訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="insertMessageWithMsg:" %}{% endlanying_code_snippet %}

insertMessageWithMsg:completion:#

插入一條訊息

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

Parameters#

msg
插入的訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="insertMessageWithMsg:completion:" %}{% endlanying_code_snippet %}

isMuteNotification#

是否提醒使用者訊息,不提醒的情況下會話總未讀數不會統計該會話計數。

- (BOOL)isMuteNotification

Return Value#

BOOL

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="isMuteNotification" %}{% endlanying_code_snippet %}

lastMsg#

最新訊息

- (BMXMessage *)lastMsg

Return Value#

BMXMessage

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="lastMsg" %}{% endlanying_code_snippet %}

loadMessageWithMsgId:#

讀取一條訊息

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

Parameters#

msgId
需要讀取的訊息的訊息id

Return Value#

BMXMessage

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessageWithMsgId:" %}{% endlanying_code_snippet %}

loadMessageWithMsgId:completion:#

讀取一條訊息

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

Parameters#

msgId
需要讀取的訊息的訊息id

Return Value#

BMXMessage

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessageWithMsgId:completion:" %}{% endlanying_code_snippet %}

loadMessagesWithRefMsgId:size:arg4:completion:#

加載訊息，如果不指定則從最新訊息開始

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

Parameters#

refMsgId
加載訊息的起始id

size
最大加載訊息條數

result
資料庫回傳的加載訊息列表

Direction
加載訊息的方向，預設是加載更早的訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessagesWithRefMsgId:size:arg4:completion:" %}{% endlanying_code_snippet %}

loadMessagesWithRefMsgId:size:completion:#

搜索訊息，如果不指定則從最新訊息開始

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

Parameters#

size
最大加載訊息條數

refTime
搜索訊息的起始時間

result
搜索到的訊息結果列表

keywords
搜索訊息的關鍵字

Direction
訊息搜索方向，預設（Direction::Up）是從更早的訊息中搜索

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessagesWithRefMsgId:size:completion:" %}{% endlanying_code_snippet %}

loadMessagesWithRefMsgId:size:result:#

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

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessagesWithRefMsgId:size:result:" %}{% endlanying_code_snippet %}

loadMessagesWithRefMsgId:size:result:arg4:#

加載訊息，如果不指定則從最新訊息開始

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

Parameters#

refMsgId
加載訊息的起始id

size
最大加載訊息條數

result
資料庫回傳的加載訊息列表

Direction
加載訊息的方向，預設是加載更早的訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="loadMessagesWithRefMsgId:size:result:arg4:" %}{% endlanying_code_snippet %}

messageCount#

會話中所有訊息的數量

- (int)messageCount

Return Value#

int

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="messageCount" %}{% endlanying_code_snippet %}

refreshConversation#

讀取資料庫當前會話所有訊息數量，強制更新conversation的訊息總數和未讀訊息數。

- (BMXErrorCode)refreshConversation

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="refreshConversation" %}{% endlanying_code_snippet %}

refreshConversationWithCompletion:#

讀取資料庫當前會話所有訊息數量，強制更新conversation的訊息總數和未讀訊息數。

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

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="refreshConversationWithCompletion:" %}{% endlanying_code_snippet %}

removeAllMessages#

刪除會話中的所有訊息

- (BMXErrorCode)removeAllMessages

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="removeAllMessages" %}{% endlanying_code_snippet %}

removeAllMessagesWithCompletion:#

刪除會話中的所有訊息

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

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="removeAllMessagesWithCompletion:" %}{% endlanying_code_snippet %}

searchMessagesByKeyWordsWithKeywords:refTime:size:arg5:completion:#

搜索訊息，如果不指定則從最新訊息開始

- (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
搜索訊息的關鍵字

refTime
搜索訊息的起始時間

size
最大加載訊息條數

result
搜索到的訊息結果列表

Direction
訊息搜索方向，預設（Direction::Up）是從更早的訊息中搜索

Return Value#

BMXErrorCode

Discussion#

Deprecated. use searchMessagesByKeyWords instead.

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByKeyWordsWithKeywords:refTime:size:arg5:completion:" %}{% endlanying_code_snippet %}

searchMessagesByKeyWordsWithKeywords:refTime:size:completion:#

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

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByKeyWordsWithKeywords:refTime:size:completion:" %}{% endlanying_code_snippet %}

searchMessagesByKeyWordsWithKeywords:refTime:size:result:#

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

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByKeyWordsWithKeywords:refTime:size:result:" %}{% endlanying_code_snippet %}

searchMessagesByKeyWordsWithKeywords:refTime:size:result:arg5:#

搜索訊息，如果不指定則從最新訊息開始

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

Parameters#

keywords
搜索訊息的關鍵字

refTime
搜索訊息的起始時間

size
最大加載訊息條數

result
搜索到的訊息結果列表

arg5
訊息搜索方向，預設（Direction::Up）是從更早的訊息中搜索

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByKeyWordsWithKeywords:refTime:size:result:arg5:" %}{% endlanying_code_snippet %}

searchMessagesByTypeWithType:refTime:size:arg5:completion:#

按照類型搜索訊息，如果不指定則從最新訊息開始

- (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
搜索訊息的類型

refTime
搜索訊息的起始時間

size
最大加載訊息條數

result
搜索到的訊息結果列表

Direction
訊息搜索方向，預設（Direction::Up）是從更早的訊息中搜索

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByTypeWithType:refTime:size:arg5:completion:" %}{% endlanying_code_snippet %}

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:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByTypeWithType:refTime:size:completion:" %}{% endlanying_code_snippet %}

searchMessagesByTypeWithType:refTime:size:result:#

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

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByTypeWithType:refTime:size:result:" %}{% endlanying_code_snippet %}

searchMessagesByTypeWithType:refTime:size:result:arg5:#

按照類型搜索訊息，如果不指定則從最新訊息開始

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

Parameters#

type
搜索訊息的類型

refTime
搜索訊息的起始時間

size
最大加載訊息條數

result
搜索到的訊息結果列表

Direction
訊息搜索方向，預設（Direction::Up）是從更早的訊息中搜索

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="searchMessagesByTypeWithType:refTime:size:result:arg5:" %}{% endlanying_code_snippet %}

setAllMessagesRead#

把所有訊息設定為已讀，更新未讀訊息數

- (BMXErrorCode)setAllMessagesRead

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setAllMessagesRead" %}{% endlanying_code_snippet %}

setAllMessagesReadWithCompletion:#

把所有訊息設定為已讀，更新未讀訊息數

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

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setAllMessagesReadWithCompletion:" %}{% endlanying_code_snippet %}

setEditMessage:#

設定編輯訊息

- (BMXErrorCode)setEditMessage:(NSString )editMessage*

Parameters#

editMessage
會話正在編輯的文本訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setEditMessage:" %}{% endlanying_code_snippet %}

setExtension:#

設定擴展信息

- (BMXErrorCode)setExtension:(NSString )ext*

Parameters#

ext
會話擴展訊息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setExtension:" %}{% endlanying_code_snippet %}

setMessagePlayedStatus:status:#

設定訊息播放狀態（只對語音/視訊訊息有效）

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

Parameters#

msg
需要設定播放狀態的訊息

status
訊息是否已經播放

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setMessagePlayedStatus:status:" %}{% endlanying_code_snippet %}

setMessagePlayedStatus:status:completion:#

設定訊息播放狀態（只對語音/視訊訊息有效）

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

Parameters#

msg
需要設定播放狀態的訊息

status
訊息是否已經播放

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setMessagePlayedStatus:status:completion:" %}{% endlanying_code_snippet %}

setMessageReadStatus:status:#

設定訊息未讀狀態，更新未讀訊息數

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

Parameters#

msg
需要設定訊息已讀狀態的訊息

status
訊息是否設定已讀

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setMessageReadStatus:status:" %}{% endlanying_code_snippet %}

setMessageReadStatus:status:completion:#

設定訊息未讀狀態，更新未讀訊息數

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

Parameters#

msg
需要設定訊息已讀狀態的訊息

status
訊息是否設定已讀

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="setMessageReadStatus:status:completion:" %}{% endlanying_code_snippet %}

type#

會話類型

- (BMXConversation_Type)type

Return Value#

BMXConversation_Type

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="type" %}{% endlanying_code_snippet %}

unreadNumber#

未讀訊息數

- (int)unreadNumber

Return Value#

int

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="unreadNumber" %}{% endlanying_code_snippet %}

updateMessageExtensionWithMsg:#

更新一條資料庫存儲訊息的擴展欄位信息

- (BMXErrorCode)updateMessageExtensionWithMsg:(BMXMessage )msg*

Parameters#

msg
需要更改擴展信息的訊息此時msg部分已經更新擴展字椴信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="updateMessageExtensionWithMsg:" %}{% endlanying_code_snippet %}

updateMessageExtensionWithMsg:completion:#

更新一條資料庫存儲訊息的擴展欄位信息

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

Parameters#

msg
需要更改擴展信息的訊息此時msg部分已經更新擴展字椴信息

Return Value#

BMXErrorCode

Declared In#

• floo_proxy.h

Example:

{% lanying_code_snippet repo="lanying-im-ios",class="BMXConversation",function="updateMessageExtensionWithMsg:completion:" %}{% endlanying_code_snippet %}