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

Example:

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

Example:

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

Example:

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

Example:

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

Example:

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

Example:

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
Messsage content

serverTimestamp
Message timestamp on server

Declared In

  • floo_proxy.h

Example:

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
Messsage content

Declared In

  • floo_proxy.h

Example:

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
Messsage content

serverTimestamp
Message timestamp on server

Declared In

  • floo_proxy.h

Instance Methods

Example:

attachment

Message attachment

- (BMXMessageAttachment *)attachment

Return Value

BMXMessageAttachment

Declared In

  • floo_proxy.h

Example:

clientMsgId

Client ID of Messsage

- (long long)clientMsgId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

clientTimestamp

Local timestamp

- (long long)clientTimestamp

Return Value

long long

Declared In

  • floo_proxy.h

Example:

config

Message config

- (BMXMessageConfig *)config

Return Value

BMXMessageConfig

Declared In

  • floo_proxy.h

Example:

content

Text content of the message

- (NSString *)content

Return Value

NSString

Declared In

  • floo_proxy.h

Example:

contentType

Message content type

- (BMXMessage_ContentType)contentType

Return Value

ContentType

Declared In

  • floo_proxy.h

Example:

conversationId

Conversation ID

- (long long)conversationId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

dealloc

- (void)dealloc

Example:

deliveryQos

Delivery QOS of message

- (BMXMessage_DeliveryQos)deliveryQos

Return Value

BMXMessage_DeliveryQos

Declared In

  • floo_proxy.h

Example:

deliveryStatus

Message delivery status

- (BMXMessage_DeliveryStatus)deliveryStatus

Return Value

BMXMessage_DeliveryStatus

Declared In

  • floo_proxy.h

Example:

extension

Extension information of message

- (NSString *)extension

Return Value

NSString

Declared In

  • floo_proxy.h

Example:

fromId

Sender ID

- (long long)fromId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

groupAckCount

The number of users who have read the group message

- (int)groupAckCount

Return Value

int

Declared In

  • floo_proxy.h

Example:

groupAckReadAll

Whether the group message has been read by everyone

- (BOOL)groupAckReadAll

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

groupAckUnreadCount

The number of users who have NOT read the group message

- (int)groupAckUnreadCount

Return Value

int

Declared In

  • floo_proxy.h

Example:

groupPlayAckCount

The number of users who have played the group message

- (int)groupPlayAckCount

Return Value

int

Declared In

  • floo_proxy.h

Example:

groupPlayAckReadAll

Whether the group message has been played by everyone

- (BOOL)groupPlayAckReadAll

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

groupPlayAckUnreadCount

The number of users who have NOT played the group message

- (int)groupPlayAckUnreadCount

Return Value

int

Declared In

  • floo_proxy.h

Example:

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

Example:

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

Example:

isPlayed

Whether the message has been played

- (BOOL)isPlayed

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

isPushMessage

Is it a push message

- (BOOL)isPushMessage

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

isRead

Whether the message has been read

- (BOOL)isRead

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

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

Example:

isReceiveMsg

Is it a received message

- (BOOL)isReceiveMsg

Return Value

BOOL

Declared In

  • floo_proxy.h

Example:

msgId

Message ID

- (long long)msgId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

priority

Message Diffusion Priority

- (int)priority

Return Value

int

Declared In

  • floo_proxy.h

Example:

senderName

Sender name

- (NSString *)senderName

Return Value

NSString

Declared In

  • floo_proxy.h

Example:

serverTimestamp

Message timestamp on server

- (long long)serverTimestamp

Return Value

long long

Declared In

  • floo_proxy.h

Example:

setClientTimestamp:

Set local timestamp of the message

- (void)setClientTimestamp:(long long)*arg1*

Declared In

  • floo_proxy.h

Example:

setConfig:

Set message config

- (void)setConfig:(BMXMessageConfig *)*arg1*

Declared In

  • floo_proxy.h

Example:

setContent:

Set message content

- (void)setContent:(NSString *)*content*

Parameters

content
Text content

Declared In

  • floo_proxy.h

Example:

setDeliveryQos:

Set delivery QOS

- (void)setDeliveryQos:(BMXMessage_DeliveryQos)*qos*

Parameters

qos
Delivery QOS

Declared In

  • floo_proxy.h

Example:

setDeliveryStatus:

Set delivery status

- (void)setDeliveryStatus:(BMXMessage_DeliveryStatus)*arg1*

Declared In

  • floo_proxy.h

Example:

setExtension:

Set extension information

- (void)setExtension:(NSString *)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsDeliveryAcked:

Set delivery ACK sent or received

- (void)setIsDeliveryAcked:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsPlayAcked:

Set play ACK sent or received

- (void)setIsPlayAcked:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsPlayed:

Set play ACK sent or received

- (void)setIsPlayed:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsRead:

Set the message has been read

- (void)setIsRead:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsReadAcked:

Set read ACK sent or received

- (void)setIsReadAcked:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setIsReceiveMsg:

Set it as a received message

- (void)setIsReceiveMsg:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

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

Example:

setPushMessageMode:

Set it as a push message

- (void)setPushMessageMode:(BOOL)*arg1*

Declared In

  • floo_proxy.h

Example:

setSenderName:

Set sender name

- (void)setSenderName:(NSString *)*senderName*

Parameters

senderName
Sender name

Declared In

  • floo_proxy.h

Example:

setServerTimestamp:

Set the server-side timestamp of the message

- (void)setServerTimestamp:(long long)*arg1*

Declared In

  • floo_proxy.h

Example:

toId

Receiver ID

- (long long)toId

Return Value

long long

Declared In

  • floo_proxy.h

Example:

type

Message type

- (BMXMessage_MessageType)type

Return Value

BMXMessage_MessageType

Declared In

  • floo_proxy.h

Example:

© 2019-2023 MaximTop | Homepage Last modified time: 2023-05-17 17:35:58

results matching ""

    No results matching ""