Message Class Reference

#import <Message.h>

Inheritance diagram for Message:

Instance Methods
(id)	- initWithConversationID:from:to:body:ext:

Properties
NSString *	messageId
NSString *	conversationId
MessageDirection	direction
NSString *	from
NSString *	to
long long	timestamp
long long	localTime
AgoraChatType	chatType
MessageStatus	status
BOOL	isReadAcked
BOOL	isNeedGroupAck
int	groupAckCount
BOOL	isDeliverAcked
BOOL	isRead
BOOL	isListened
MessageBody *	body
NSDictionary *	ext

Detailed Description

Chat message

Method Documentation

- (id) initWithConversationID:		(NSString *)	aConversationId
from:		(NSString *)	aFrom
to:		(NSString *)	aTo
body:		(MessageBody *)	aBody
ext:		(NSDictionary *)	aExt

Initialize a message instance

Parameters

aConversationId	Conversation id
aFrom	Sender
aTo	Receiver
aBody	Message body
aExt	Message extention

Returns

Message instance

Property Documentation

- (MessageBody*) body

readwritenonatomicstrong

Message body

- (AgoraChatType) chatType

readwritenonatomicassign

Chat type

- (NSString*) conversationId

readwritenonatomiccopy

Unique identifier of conversation, the message's container object

- (MessageDirection) direction

readwritenonatomicassign

Message delivery direction

- (NSDictionary*) ext

readwritenonatomiccopy

Message extension

Key type must be NSString. Value type must be NSString, or NSNumber object (including int, unsigned in, long long, double, use NSNumber (/) instead of BOOL).

- (NSString*) from

readwritenonatomiccopy

Message sender

- (int) groupAckCount

readnonatomicassign

Number of group confirmation messages

- (BOOL) isDeliverAcked

readwritenonatomicassign

Acknowledge if the message is delivered. It indicates whether the sender has received a message deliver acknowledgement; or whether the recipient has sent a message deliver acknowledgement. SDK will automatically send delivery acknowledgement if AgoraOptions is set to enableDeliveryAck

- (BOOL) isListened

readwritenonatomicassign

Whether the message has been listen

- (BOOL) isNeedGroupAck

readwritenonatomicassign

Whether need group confirmation

- (BOOL) isRead

readwritenonatomicassign

Whether the message has been read

- (BOOL) isReadAcked

readwritenonatomicassign

Acknowledge if the message is read by the receipient. It indicates whether the sender has received a message read acknowledgement; or whether the recipient has sent a message read acknowledgement

- (long long) localTime

readwritenonatomicassign

The time of client sends/receives the message

- (NSString*) messageId

readwritenonatomiccopy

Unique identifier of the message

- (MessageStatus) status

readwritenonatomicassign

Message delivery status type

- (long long) timestamp

readwritenonatomicassign

Timestamp, the time of server received the message

- (NSString*) to

readwritenonatomiccopy

Message receiver

---

The documentation for this class was generated from the following file:

• AgoraChat.framework/Headers/Message.h