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 %}