BMXMessage Class Reference#
Inherits from BMXBaseObject :
NSObject
Declared in floo_proxy.h
Overview#
@interface Message
Class Methods#
createCommandMessageWithFrom:to:type:conversationId:content:#
Create a COMMAND message to send
+ (BMXMessage )createCommandMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
Declared In#
floo_proxy.h
createCommandMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
Create a COMMAND message received
+ (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
Message ID
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
serverTimestamp
Message timestamp on server
Declared In#
floo_proxy.h
createForwardMessageWithMsg:from:to:type:conversationId:#
Create a message to forward
+ (BMXMessage )createForwardMessageWithMsg:(BMXMessage )msg from:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId
Parameters#
msg
Message to be forward
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
Declared In#
floo_proxy.h
createMessageWithFrom:to:type:conversationId:attachment:#
Create a message with an attachment
+ (BMXMessage )createMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId attachment:(BMXMessageAttachment )attachment
Parameters#
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
attachment
The attachment
Declared In#
floo_proxy.h
createMessageWithFrom:to:type:conversationId:content:#
Create a text message
+ (BMXMessage )createMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
Declared In#
floo_proxy.h
createMessageWithMsgId:from:to:type:conversationId:attachment:serverTimestamp:#
Create a received message
+ (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
Message ID
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
attachment
The attachment
serverTimestamp
Message timestamp on server
Declared In#
floo_proxy.h
createMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
Create a received message
+ (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
Message ID
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
serverTimestamp
Message timestamp on server
Declared In#
floo_proxy.h
createRTCMessageWithFrom:to:type:conversationId:content:#
Create an RTC Messsage
+ (BMXMessage )createRTCMessageWithFrom:(long long)from to:(long long)to type:(BMXMessage_MessageType)type conversationId:(long long)conversationId content:(NSString )content
Parameters#
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
Declared In#
floo_proxy.h
createRTCMessageWithMsgId:from:to:type:conversationId:content:serverTimestamp:#
Create an RTC message received
+ (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
Message ID
from
Message sender
to
Message receiver
type
Message type
conversationId
Conversation ID
content
Message content
serverTimestamp
Message timestamp on server
Declared In#
floo_proxy.h
Instance Methods#
attachment#
Message attachment
- (BMXMessageAttachment *)attachment
Return Value#
Declared In#
floo_proxy.h
clientMsgId#
Client ID of Messsage
- (long long)clientMsgId
Return Value#
long long
Declared In#
floo_proxy.h
clientTimestamp#
Local timestamp
- (long long)clientTimestamp
Return Value#
long long
Declared In#
floo_proxy.h
config#
Message config
- (BMXMessageConfig *)config
Return Value#
Declared In#
floo_proxy.h
content#
Text content of the message
- (NSString *)content
Return Value#
NSString
Declared In#
floo_proxy.h
contentType#
Message content type
- (BMXMessage_ContentType)contentType
Return Value#
ContentType
Declared In#
floo_proxy.h
conversationId#
Conversation ID
- (long long)conversationId
Return Value#
long long
Declared In#
floo_proxy.h
dealloc#
- (void)dealloc
deliveryQos#
Delivery QOS of message
- (BMXMessage_DeliveryQos)deliveryQos
Return Value#
Declared In#
floo_proxy.h
deliveryStatus#
Message delivery status
- (BMXMessage_DeliveryStatus)deliveryStatus
Return Value#
Declared In#
floo_proxy.h
extension#
Extension information of message
- (NSString *)extension
Return Value#
NSString
Declared In#
floo_proxy.h
fromId#
Sender ID
- (long long)fromId
Return Value#
long long
Declared In#
floo_proxy.h
groupAckCount#
The number of users who have read the group message
- (int)groupAckCount
Return Value#
int
Declared In#
floo_proxy.h
groupAckReadAll#
Whether the group message has been read by everyone
- (BOOL)groupAckReadAll
Return Value#
BOOL
Declared In#
floo_proxy.h
groupAckUnreadCount#
The number of users who have NOT read the group message
- (int)groupAckUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
groupPlayAckCount#
The number of users who have played the group message
- (int)groupPlayAckCount
Return Value#
int
Declared In#
floo_proxy.h
groupPlayAckReadAll#
Whether the group message has been played by everyone
- (BOOL)groupPlayAckReadAll
Return Value#
BOOL
Declared In#
floo_proxy.h
groupPlayAckUnreadCount#
The number of users who have NOT played the group message
- (int)groupPlayAckUnreadCount
Return Value#
int
Declared In#
floo_proxy.h
isDeliveryAcked#
For the sender, it indicates whether the message has been delivered to the receiver, and for the receiver, it indicates whether the read ACK has been sent.
- (BOOL)isDeliveryAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isPlayAcked#
For the sender, it indicates whether the message has been played by the receiver, and for the receiver, it indicates whether the play ACK has been sent.
- (BOOL)isPlayAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isPlayed#
Whether the message has been played
- (BOOL)isPlayed
Return Value#
BOOL
Declared In#
floo_proxy.h
isPushMessage#
Is it a push message
- (BOOL)isPushMessage
Return Value#
BOOL
Declared In#
floo_proxy.h
isRead#
Whether the message has been read
- (BOOL)isRead
Return Value#
BOOL
Declared In#
floo_proxy.h
isReadAcked#
For the sender, it indicates whether the message has been read by the receiver, and for the receiver, it indicates whether the read ACK has been sent.
- (BOOL)isReadAcked
Return Value#
BOOL
Declared In#
floo_proxy.h
isReceiveMsg#
Is it a received message
- (BOOL)isReceiveMsg
Return Value#
BOOL
Declared In#
floo_proxy.h
msgId#
Message ID
- (long long)msgId
Return Value#
long long
Declared In#
floo_proxy.h
priority#
Message Diffusion Priority
- (int)priority
Return Value#
int
Declared In#
floo_proxy.h
senderName#
Sender name
- (NSString *)senderName
Return Value#
NSString
Declared In#
floo_proxy.h
serverTimestamp#
Message timestamp on server
- (long long)serverTimestamp
Return Value#
long long
Declared In#
floo_proxy.h
setClientTimestamp:#
Set local timestamp of the message
- (void)setClientTimestamp:(long long)arg1
Declared In#
floo_proxy.h
setConfig:#
Set message config
- (void)setConfig:(BMXMessageConfig )arg1*
Declared In#
floo_proxy.h
setContent:#
Set message content
- (void)setContent:(NSString )content*
Parameters#
content
Text content
Declared In#
floo_proxy.h
setDeliveryQos:#
Set delivery QOS
- (void)setDeliveryQos:(BMXMessage_DeliveryQos)qos
Parameters#
qos
Delivery QOS
Declared In#
floo_proxy.h
setDeliveryStatus:#
Set delivery status
- (void)setDeliveryStatus:(BMXMessage_DeliveryStatus)arg1
Declared In#
floo_proxy.h
setExtension:#
Set extension information
- (void)setExtension:(NSString )arg1*
Declared In#
floo_proxy.h
setGroupAckCount:#
Set delivery ACK sent or received
- (void)setGroupAckCount:(int)count
Parameters#
count
Sets the number of read group messages
Declared In#
floo_proxy.h
setGroupAckUnreadCount:#
Set groupAckCount of unread messages (an SDK internal calling interface that shall not be called by upper layer)
- (void)setGroupAckUnreadCount:(int)count
Parameters#
count
Sets the number of unread group messages
Declared In#
floo_proxy.h
setGroupPlayAckCount:#
Set groupAckCount of played messages (an SDK internal calling interface that shall not be called by upper layer) (valid only for messages with audio/video attachment)
- (void)setGroupPlayAckCount:(int)count
Parameters#
count
Sets the number of read group messages
Declared In#
floo_proxy.h
setGroupPlayAckUnreadCount:#
Set groupAckCount of unplayed messages (an SDK internal calling interface that shall not be called by upper layer) (valid only for messages with audio/video attachment)
- (void)setGroupPlayAckUnreadCount:(int)count
Parameters#
count
Sets the number of unplayed group messages
Declared In#
floo_proxy.h
setIsDeliveryAcked:#
Set delivery acknowledgement
- (void)setIsDeliveryAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsPlayAcked:#
Set play ACK sent or received
- (void)setIsPlayAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsPlayed:#
Set play ACK sent or received
- (void)setIsPlayed:(BOOL)arg1
Declared In#
floo_proxy.h
setIsRead:#
Set the message has been read
- (void)setIsRead:(BOOL)arg1
Declared In#
floo_proxy.h
setIsReadAcked:#
Set read ACK sent or received
- (void)setIsReadAcked:(BOOL)arg1
Declared In#
floo_proxy.h
setIsReceiveMsg:#
Set it as a received message
- (void)setIsReceiveMsg:(BOOL)arg1
Declared In#
floo_proxy.h
setPriority:#
[0-10]. The priority of messages sent by members in the chat room is 5 by default, and messages can be discarded. For administrators, the priority defaults to 0, and messages are not dropped. Other values can be set as required
- (void)setPriority:(int)priority
Parameters#
priority
Priority value
Declared In#
floo_proxy.h
setPushMessageMode:#
Set it as a push message
- (void)setPushMessageMode:(BOOL)arg1
Declared In#
floo_proxy.h
setSenderName:#
Set sender name
- (void)setSenderName:(NSString )senderName*
Parameters#
senderName
Sender name
Declared In#
floo_proxy.h
setServerTimestamp:#
Set the server-side timestamp of the message
- (void)setServerTimestamp:(long long)arg1
Declared In#
floo_proxy.h
toId#
Receiver ID
- (long long)toId
Return Value#
long long
Declared In#
floo_proxy.h
type#
Message type
- (BMXMessage_MessageType)type
Return Value#
Declared In#
floo_proxy.h