BMXMessage Class Reference#
Inherits from BMXBaseObject :
NSObject
Declared in floo_proxy.h
Overview#
@interface 訊息
Class Methods#
createCommandMessageWithFrom:to:type:conversationId:content:#
建立發送命令訊息(命令訊息通過content欄位或者extension欄位存放命令信息)
+ (BMXMessage )createCommandMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
Declared In#
floo_proxy.h
createCommandMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
建立收到的命令訊息(命令訊息通過content欄位或者extension欄位存放命令信息)
+ (BMXMessage )createCommandMessageWithMsgId:(long long)msgId from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content serverTimestamp:(long long)serverTimestamp
Parameters#
msgId
訊息id
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
serverTimestamp
伺服器時間戳
Declared In#
floo_proxy.h
createForwardMessageWithMsg:from:to:type:conversationId:#
建立轉發訊息
+ (BMXMessage )createForwardMessageWithMsg:(BMXMessage )msg from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId
Parameters#
msg
要轉發的訊息
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
Declared In#
floo_proxy.h
createMessageWithFrom:to:type:conversationId:attachment:#
建立發送附件訊息
+ (BMXMessage )createMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId attachment:(BMXMessageAttachment )attachment
Parameters#
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
attachment
附件
Declared In#
floo_proxy.h
createMessageWithFrom:to:type:conversationId:content:#
建立發送文本訊息
+ (BMXMessage )createMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
Declared In#
floo_proxy.h
createMessageWithMsgId:from:to:type:conversationId:attachment:serverTimestamp:#
建立收到的訊息
+ (BMXMessage )createMessageWithMsgId:(long long)msgId from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId attachment:(BMXMessageAttachment )attachment serverTimestamp:(long long)serverTimestamp
Parameters#
msgId
訊息id
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
attachment
附件
serverTimestamp
伺服器時間戳
Declared In#
floo_proxy.h
createMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
建立收到的訊息
+ (BMXMessage )createMessageWithMsgId:(long long)msgId from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content serverTimestamp:(long long)serverTimestamp
Parameters#
msgId
訊息id
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
serverTimestamp
伺服器時間戳
Declared In#
floo_proxy.h
createRTCMessageWithFrom:to:type:conversationId:content:#
建立發送RTC訊息
+ (BMXMessage )createRTCMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
Declared In#
floo_proxy.h
createRTCMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
建立收到的RTC訊息
+ (BMXMessage )createRTCMessageWithMsgId:(long long)msgId from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content serverTimestamp:(long long)serverTimestamp
Parameters#
msgId
訊息id
from
訊息發送者
to
訊息接收者
type
訊息類型
conversationId
會話id
content
訊息內容
serverTimestamp
伺服器時間戳
Declared In#
floo_proxy.h
Instance Methods#
attachment#
訊息附件，BMXMessage擁有附件的所有權，負責釋放
- (BMXMessageAttachment *)attachment
Return Value#
Declared In#
floo_proxy.h
clientMsgId#
訊息客戶端ID,僅在訊息發送端存在
- (long long)clientMsgId
Return Value#
long long
Declared In#
floo_proxy.h
clientTimestamp#
本地時間戳（訊息建立或者收到時的本地時間）
- (long long)clientTimestamp
Return Value#
long long
Declared In#
floo_proxy.h
config#
訊息的配置信息
- (BMXMessageConfig *)config
Return Value#
Declared In#
floo_proxy.h
content#
訊息文本內容
- (NSString *)content
Return Value#
NSString
Declared In#
floo_proxy.h
contentType#
訊息內容類型，如果帶附件就表示附件類型，不帶附件就是文本類型
- (BMXMessage_ContentType)contentType
Return Value#
ContentType
Declared In#
floo_proxy.h
conversationId#
訊息所屬會話ID
- (long long)conversationId
Return Value#
long long
Declared In#
floo_proxy.h
dealloc#
- (void)dealloc
deliveryQos#
訊息投遞QOS
- (BMXMessage_DeliveryQos)deliveryQos
Return Value#
Declared In#
floo_proxy.h
deliveryStatus#
訊息投遞狀態
- (BMXMessage_DeliveryStatus)deliveryStatus
Return Value#
Declared In#
floo_proxy.h
extension#
訊息擴展信息
- (NSString *)extension
Return Value#
NSString
Declared In#
floo_proxy.h
fromId#
訊息發送方ID
- (long long)fromId
Return Value#
long long
Declared In#
floo_proxy.h
groupAckCount#
群訊息已讀AckCount數目
- (int)groupAckCount
Return Value#
int
Declared In#
floo_proxy.h
groupAckReadAll#
群訊息是否全部已讀
- (BOOL)groupAckReadAll
Return Value#
BOOL
Declared In#
floo_proxy.h
groupAckUnreadCount#
群訊息未讀AckCount數目
- (int)groupAckUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
groupPlayAckCount#
群訊息已播放AckCount數目（僅用於音訊/視訊附件訊息）
- (int)groupPlayAckCount
Return Value#
int
Declared In#
floo_proxy.h
groupPlayAckReadAll#
群訊息是否全部已播放
- (BOOL)groupPlayAckReadAll
Return Value#
BOOL
Declared In#
floo_proxy.h
groupPlayAckUnreadCount#
群訊息未播放AckCount數目（僅用於音訊/視訊附件訊息）
- (int)groupPlayAckUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
isDeliveryAcked#
對於發送方表示訊息是否已投遞到對方，對於接收方表示是否發送了訊息已到達回執
- (BOOL)isDeliveryAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isPlayAcked#
對於發送方表示是否收到了已播放回執，對於接收方表示是否發送了已播放回執
- (BOOL)isPlayAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isPlayed#
語音或者視訊訊息是否播放過，僅對收到的音視訊訊息有效
- (BOOL)isPlayed
Return Value#
BOOL
Declared In#
floo_proxy.h
isPushMessage#
訊息是否是推播訊息
- (BOOL)isPushMessage
Return Value#
BOOL
Declared In#
floo_proxy.h
isRead#
訊息是否已讀標誌
- (BOOL)isRead
Return Value#
BOOL
Declared In#
floo_proxy.h
isReadAcked#
對於發送方表示是否收到了已讀回執，對於接收方表示是否發送了已讀回執
- (BOOL)isReadAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isReceiveMsg#
是否接收的訊息
- (BOOL)isReceiveMsg
Return Value#
BOOL
Declared In#
floo_proxy.h
msgId#
訊息唯一ID
- (long long)msgId
Return Value#
long long
Declared In#
floo_proxy.h
priority#
訊息的擴散優先級
- (int)priority
Return Value#
int
Declared In#
floo_proxy.h
senderName#
訊息發送者的顯示名稱
- (NSString *)senderName
Return Value#
NSString
Declared In#
floo_proxy.h
serverTimestamp#
訊息時間戳（服務端收到時的時間）
- (long long)serverTimestamp
Return Value#
long long
Declared In#
floo_proxy.h
setClientTimestamp:#
設定訊息本地時間戳
- (void)setClientTimestamp:(long long)arg1
Declared In#
floo_proxy.h
setConfig:#
設定訊息配置信息
- (void)setConfig:(BMXMessageConfig )arg1*
Declared In#
floo_proxy.h
setContent:#
訊息文本內容
- (void)setContent:(NSString )content*
Parameters#
content
訊息文本內容
Declared In#
floo_proxy.h
setDeliveryQos:#
設定訊息投遞QOS
- (void)setDeliveryQos:(BMXMessage_DeliveryQos)qos
Parameters#
qos
訊息投遞QOS
Declared In#
floo_proxy.h
setDeliveryStatus:#
設定訊息投遞狀態
- (void)setDeliveryStatus:(BMXMessage_DeliveryStatus)arg1
Declared In#
floo_proxy.h
setExtension:#
設定訊息擴展信息
- (void)setExtension:(NSString )arg1*
Declared In#
floo_proxy.h
setGroupAckCount:#
設定訊息已讀groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)
- (void)setGroupAckCount:(int)count
Parameters#
count
設定群訊息已讀數目
Declared In#
floo_proxy.h
setGroupAckUnreadCount:#
設定訊息未讀groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)
- (void)setGroupAckUnreadCount:(int)count
Parameters#
count
設定群訊息未讀數目
Declared In#
floo_proxy.h
setGroupPlayAckCount:#
設定訊息已播放groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)（僅用於音訊/視訊附件訊息）
- (void)setGroupPlayAckCount:(int)count
Parameters#
count
設定群訊息已讀數目
Declared In#
floo_proxy.h
setGroupPlayAckUnreadCount:#
設定訊息未播放groupAckCount數目(SDK 內部呼叫介面，上層不應該呼叫)（僅用於音訊/視訊附件訊息）
- (void)setGroupPlayAckUnreadCount:(int)count
Parameters#
count
設定群訊息未播放數目
Declared In#
floo_proxy.h
setIsDeliveryAcked:#
設定投遞迴執
- (void)setIsDeliveryAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsPlayAcked:#
設定已播放回執
- (void)setIsPlayAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsPlayed:#
設定語音或者視訊訊息是否播放過，僅對收到的音視訊訊息有效
- (void)setIsPlayed:(BOOL)arg1
Declared In#
floo_proxy.h
setIsRead:#
訊息是否已讀標誌
- (void)setIsRead:(BOOL)arg1
Declared In#
floo_proxy.h
setIsReadAcked:#
設定已讀回執
- (void)setIsReadAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsReceiveMsg:#
設定是否接收的訊息
- (void)setIsReceiveMsg:(BOOL)arg1
Declared In#
floo_proxy.h
setPriority:#
取值範圍0-10。普通人在聊天室發送的訊息級別預設為5，可以丟棄。管理員預設為0不會丟棄。其它值可以根據業務自行設定。
- (void)setPriority:(int)priority
Parameters#
priority
優先級
Declared In#
floo_proxy.h
setPushMessageMode:#
設定訊息是否為推播訊息。
- (void)setPushMessageMode:(BOOL)arg1
Declared In#
floo_proxy.h
setSenderName:#
設定訊息的發送者顯示名稱
- (void)setSenderName:(NSString )senderName*
Parameters#
senderName
訊息文本內容
Declared In#
floo_proxy.h
setServerTimestamp:#
設定時間戳（服務端收到時的時間）
- (void)setServerTimestamp:(long long)arg1
Declared In#
floo_proxy.h
toId#
訊息接收方ID
- (long long)toId
Return Value#
long long
Declared In#
floo_proxy.h
type#
訊息類型
- (BMXMessage_MessageType)type
Return Value#
Declared In#
floo_proxy.h