藍鶯開發者
Web & Mini ProgramiOSAndroidC++Server API

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:

dealloc#

- (void)dealloc


Example:

editMessage#

編輯訊息

- (NSString *)editMessage

Return Value#

NSString

Declared In#

  • floo_proxy.h


Example:

extension#

擴展信息

- (NSString *)extension

Return Value#

NSString

Declared In#

  • floo_proxy.h


Example:

insertMessageWithMsg:#

插入一條訊息

- (BMXErrorCode)insertMessageWithMsg:(BMXMessage )msg*

Parameters#

msg
插入的訊息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

insertMessageWithMsg:completion:#

插入一條訊息

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

Parameters#

msg
插入的訊息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

isMuteNotification#

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

- (BOOL)isMuteNotification

Return Value#

BOOL

Declared In#

  • floo_proxy.h


Example:

lastMsg#

最新訊息

- (BMXMessage *)lastMsg

Return Value#

BMXMessage

Declared In#

  • floo_proxy.h


Example:

loadMessageWithMsgId:#

讀取一條訊息

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

Parameters#

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

Return Value#

BMXMessage

Declared In#

  • floo_proxy.h


Example:

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:

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:

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:

loadMessagesWithRefMsgId:size:result:#

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


Example:

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:

messageCount#

會話中所有訊息的數量

- (int)messageCount

Return Value#

int

Declared In#

  • floo_proxy.h


Example:

refreshConversation#

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

- (BMXErrorCode)refreshConversation

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

refreshConversationWithCompletion:#

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

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

removeAllMessages#

刪除會話中的所有訊息

- (BMXErrorCode)removeAllMessages

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

removeAllMessagesWithCompletion:#

刪除會話中的所有訊息

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

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:

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:#

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

- (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:

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:

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:#

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

- (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:

setAllMessagesRead#

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

- (BMXErrorCode)setAllMessagesRead

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setAllMessagesReadWithCompletion:#

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

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setEditMessage:#

設定編輯訊息

- (BMXErrorCode)setEditMessage:(NSString )editMessage*

Parameters#

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setExtension:#

設定擴展信息

- (BMXErrorCode)setExtension:(NSString )ext*

Parameters#

ext
會話擴展訊息

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

setMessagePlayedStatus:status:#

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

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

Parameters#

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

status
訊息是否已經播放

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

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:

setMessageReadStatus:status:#

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

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

Parameters#

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

status
訊息是否設定已讀

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

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:

type#

會話類型

- (BMXConversation_Type)type

Return Value#

BMXConversation_Type

Declared In#

  • floo_proxy.h


Example:

unreadNumber#

未讀訊息數

- (int)unreadNumber

Return Value#

int

Declared In#

  • floo_proxy.h


Example:

updateMessageExtensionWithMsg:#

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

- (BMXErrorCode)updateMessageExtensionWithMsg:(BMXMessage )msg*

Parameters#

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h


Example:

updateMessageExtensionWithMsg:completion:#

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

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

Parameters#

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

Return Value#

BMXErrorCode

Declared In#

  • floo_proxy.h
自動產生的 API 內容,僅在必要位置補充精簡的 AI 解說。