<AgoraChatManagerDelegate> Protocol Reference

#import <AgoraChatManagerDelegate.h>

Inheritance diagram for <AgoraChatManagerDelegate>:

Instance Methods
(void)	- conversationListDidUpdate:
(void)	- messagesDidReceive:
(void)	- cmdMessagesDidReceive:
(void)	- messagesDidRead:
(void)	- groupMessageDidRead:groupAcks:
(void)	- groupMessageAckHasChanged
(void)	- onConversationRead:to:
(void)	- messagesDidDeliver:
(void)	- messagesInfoDidRecall:
(void)	- messageStatusDidChange:error:
(void)	- messageAttachmentStatusDidChange:error:
(void)	- onMessageContentChanged:operatorId:operationTime:
(void)	- onMessagePinChanged:conversationId:operation:pinInfo:
(void)	- messagesDidRecall:
(void)	- messageReactionDidChange:

Detailed Description

The chat related callbacks.

Method Documentation

cmdMessagesDidReceive:

- (void) cmdMessagesDidReceive: (NSArray< AgoraChatMessage * > *_Nonnull)  aCmdMessages

optional

Occurs when receiving command messages.

Parameters

aCmdMessages

The command message NSArray.

conversationListDidUpdate:

- (void) conversationListDidUpdate: (NSArray< AgoraChatConversation * > *_Nonnull)  aConversationList

optional

Occurs when the conversation list changes.

Parameters

aConversationList

The conversation NSArray. <AgoraChatConversation>

groupMessageAckHasChanged

- (void) groupMessageAckHasChanged

optional

Occurs when the current group read messages count changed.

groupMessageDidRead:groupAcks:

- (void) groupMessageDidRead: (AgoraChatMessage *_Nonnull)  aMessage groupAcks: (NSArray< AgoraChatGroupMessageAck * > *_Nonnull)  aGroupAcks

optional

Occurs when the SDK receives read receipts for group messages.

Parameters

aMessage	The acknowledged message.
aGroupAcks	The read acks of the message.

messageAttachmentStatusDidChange:error:

- (void) messageAttachmentStatusDidChange: (AgoraChatMessage *_Nonnull)  aMessage error: (AgoraChatError *_Nullable)  aError

optional

Occurs when the message attachment status changed.

Parameters

aMessage	The message whose attachment status has changed.
aError	The error information.

messageReactionDidChange:

- (void) messageReactionDidChange: (NSArray< AgoraChatMessageReactionChange * > *_Nonnull)  changes

optional

Occurs when the Reaction data changes.

Parameters

changes

The Reaction which is changed.

messagesDidDeliver:

- (void) messagesDidDeliver: (NSArray< AgoraChatMessage * > *_Nonnull)  aMessages

optional

Occurs when receiving delivered acknowledgement in message list.

Parameters

aMessages

The acknowledged message NSArray.

messagesDidRead:

- (void) messagesDidRead: (NSArray< AgoraChatMessage * > *_Nonnull)  aMessages

optional

Occurs when receiving read acknowledgement in message list.

Parameters

aMessages

The read messages.

messagesDidRecall:

- (void) messagesDidRecall: ("Use -messagesInfoDidRecall: instead")  __deprecated_msg

optional

Occurs when a received message is recalled.

Parameters

aMessages

The list of recalled messages.

Deprecated. Please use messagesInfoDidRecall: instead.

messagesDidReceive:

- (void) messagesDidReceive: (NSArray< AgoraChatMessage * > *_Nonnull)  aMessages

optional

Occurs when the SDK receives new messages.

Parameters

aMessages

The received messages. An NSArray of the <AgoraChatMessage> objects.

messagesInfoDidRecall:

- (void) messagesInfoDidRecall: (NSArray< AgoraChatRecallMessageInfo * > *_Nonnull)  aRecallMessagesInfo

optional

Occurs when a message is recalled. If the recalled message is offline, the AgoraChatRecallMessageInfo object will be an empty object.

Parameters

aRecallMessagesInfo

The list of recalled messages.

messageStatusDidChange:error:

- (void) messageStatusDidChange: (AgoraChatMessage *_Nonnull)  aMessage error: (AgoraChatError *_Nullable)  aError

optional

Occurs when message status has changed. You need to set the parameter as nil.

Parameters

aMessage	The message whose status has changed.
aError	The error information.

onConversationRead:to:

- (void) onConversationRead: (NSString *_Nonnull)  from to: (NSString *_Nonnull)  to

optional

Occurs when a conversation read receipt is received.

Parameters

from	The username who send channel_ack.
to	The username who receive channel_ack.

If the conversaion readack is from the current login ID's multiple devices: The value of the "FROM" parameter is current login ID, and the value of the "to" parameter is the conversation ID. All the messages sent by the conversation are set to read： "isRead" is set to YES. If the send conversation readack is from the conversation ID's device: The value of the "FROM" parameter is the conversation ID, and the value of the "to" parameter is current login ID. The "isReaAck" of messages sent by login ID in this session will all be set to YES. Note: This conversation is the conversation represented by the conversation ID.

onMessageContentChanged:operatorId:operationTime:

- (void) onMessageContentChanged: (AgoraChatMessage *_Nonnull)  message operatorId: (NSString *_Nonnull)  operatorId operationTime: (NSUInteger)  operationTime

optional

Occurs when the message content is modified.

Parameters

message	The modified message object, where the message body contains the information such as the number of message modifications, the operator of the last modification, and the last modification time.Also, you can get the operator of the last message modification and the last modification time via the onMessageContentChanged method.
operatorId	The user ID of the operator that modified the message last time.
operationTime	The last message modification time. It is a UNIX timestamp in milliseconds.

onMessagePinChanged:conversationId:operation:pinInfo:

- (void) onMessagePinChanged: (NSString *_Nonnull)  messageId conversationId: (NSString *_Nonnull)  conversationId operation: (AgoraChatMessagePinOperation)  pinOperation pinInfo: (AgoraChatMessagePinInfo *_Nonnull)  pinInfo

optional

Occurs when the message pinning status changed.

Parameters

messageId	The ID of the message with the changed pinning status.
conversationId	The ID of the conversation that contains the message.
pinOperation	The message pinning or unpinning operation.
pinInfo	The information about message pinning or unpinning, including the operation time and the user ID of the operater.

---

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

• AgoraChat.framework/Headers/AgoraChatManagerDelegate.h