<AgoraChatroomManagerDelegate> Protocol Reference

#import <AgoraChatroomManagerDelegate.h>

Inheritance diagram for <AgoraChatroomManagerDelegate>:

Instance Methods
(void)	- userDidJoinChatroom:user:
(void)	- userDidLeaveChatroom:user:
(void)	- didDismissFromChatroom:reason:
(void)	- chatroomSpecificationDidUpdate:
(void)	- chatroomMuteListDidUpdate:addedMutedMembers:muteExpire:
(void)	- chatroomMuteListDidUpdate:removedMutedMembers:
(void)	- chatroomWhiteListDidUpdate:addedWhiteListMembers:
(void)	- chatroomWhiteListDidUpdate:removedWhiteListMembers:
(void)	- chatroomAllMemberMuteChanged:isAllMemberMuted:
(void)	- chatroomAdminListDidUpdate:addedAdmin:
(void)	- chatroomAdminListDidUpdate:removedAdmin:
(void)	- chatroomOwnerDidUpdate:newOwner:oldOwner:
(void)	- chatroomAnnouncementDidUpdate:announcement:
(void)	- chatroomAttributesDidUpdated:attributeMap:from:
(void)	- chatroomAttributesDidRemoved:attributes:from:
(void)	- didReceiveUserJoinedChatroom:username:
(void)	- didReceiveUserLeavedChatroom:username:
(void)	- didReceiveKickedFromChatroom:reason:

Detailed Description

The callbacks of chatroom.

Method Documentation

chatroomAdminListDidUpdate:addedAdmin:

- (void) chatroomAdminListDidUpdate: (AgoraChatroom *)  aChatroom addedAdmin: (NSString *)  aAdmin

optional

A user is added to the admin list.

Parameters

aChatroom	The Chatroom
aAdmin	The user who is added to the admin list.

chatroomAdminListDidUpdate:removedAdmin:

- (void) chatroomAdminListDidUpdate: (AgoraChatroom *)  aChatroom removedAdmin: (NSString *)  aAdmin

optional

A user is removed from the admin list.

Parameters

aChatroom	The Chatroom.
aAdmin	The user who is removed from adminList.

chatroomAllMemberMuteChanged:isAllMemberMuted:

- (void) chatroomAllMemberMuteChanged: (AgoraChatroom *)  aChatroom isAllMemberMuted: (BOOL)  aMuted

optional

Whether group members are all muted.

Parameters

aChatroom	The Chatroom.
aMuted	Whether all members are muted.

chatroomAnnouncementDidUpdate:announcement:

- (void) chatroomAnnouncementDidUpdate: (AgoraChatroom *)  aChatroom announcement: (NSString *_Nullable)  aAnnouncement

optional

The announcement is updated.

Parameters

aChatroom	The Chatroom
aAnnouncement	The Announcement content.

chatroomAttributesDidRemoved:attributes:from:

- (void) chatroomAttributesDidRemoved: (NSString *_Nonnull)  roomId attributes: (NSArray< __kindof NSString * > *_Nonnull)  attributes from: (NSString *_Nonnull)  fromId

optional

The announcement is updated.

Parameters

roomid	The Chatroom's id
attributeMap	The propertyMap of chatroom
fromId	operator's id

chatroomAttributesDidUpdated:attributeMap:from:

- (void) chatroomAttributesDidUpdated: (NSString *_Nonnull)  roomId attributeMap: (NSDictionary< NSString *, NSString * > *_Nonnull)  attributeMap from: (NSString *_Nonnull)  fromId

optional

The announcement is updated.

Parameters

roomid	The Chatroom's id
attributeMap	The propertyMap of chatroom
fromId	operator's id

chatroomMuteListDidUpdate:addedMutedMembers:muteExpire:

- (void) chatroomMuteListDidUpdate: (AgoraChatroom *)  aChatroom addedMutedMembers: (NSArray< NSString * > *)  aMutes muteExpire: (NSInteger)  aMuteExpire

optional

Users are added to the mute list.

Parameters

aChatroom	The Chatroom.
aMutes	The users who are muted.
aMuteExpire	The mute expire duration, not available at this time.

chatroomMuteListDidUpdate:removedMutedMembers:

- (void) chatroomMuteListDidUpdate: (AgoraChatroom *)  aChatroom removedMutedMembers: (NSArray< NSString * > *)  aMutes

optional

Users are removed from the mute list.

Parameters

aChatroom	The Chatroom.
aMutedMembers	The users who are removed from MutedList.

chatroomOwnerDidUpdate:newOwner:oldOwner:

- (void) chatroomOwnerDidUpdate: (AgoraChatroom *)  aChatroom newOwner: (NSString *)  aNewOwner oldOwner: (NSString *)  aOldOwner

optional

The owner is updated.

Parameters

aChatroom	The Chatroom
aNewOwner	The New Owner
aOldOwner	The Old Owner

chatroomSpecificationDidUpdate:

- (void) chatroomSpecificationDidUpdate: (AgoraChatroom *)  aChatroom

optional

Occurs when the chatroom specification update,Need to call for a chat room details API (IAgoraChatroomManager. H: getChatroomSpecificationFromServerWithId) to get the latest information chat room

Parameters

aChatroom

The chatroom.

chatroomWhiteListDidUpdate:addedWhiteListMembers:

- (void) chatroomWhiteListDidUpdate: (AgoraChatroom *)  aChatroom addedWhiteListMembers: (NSArray< NSString * > *)  aMembers

optional

Users are added to the allowlist.

Parameters

aChatroom	The Chatroom.
aMutedMembers	The users who are added to allowlist.

chatroomWhiteListDidUpdate:removedWhiteListMembers:

- (void) chatroomWhiteListDidUpdate: (AgoraChatroom *)  aChatroom removedWhiteListMembers: (NSArray< NSString * > *)  aMembers

optional

Users are removed from the allowlist.

Parameters

aChatroom	The Chatroom.
aMembers	The users who are removed from the allowlist.

didDismissFromChatroom:reason:

- (void) didDismissFromChatroom: (AgoraChatroom *)  aChatroom reason: (AgoraChatroomBeKickedReason)  aReason

optional

Occurs when a user is dismissed from a chat room.

Parameters

aChatroom	The chatroom user is dismissed from.
aReason	The reason of the user was kicked out.

didReceiveKickedFromChatroom:reason:

- (void) didReceiveKickedFromChatroom: (AgoraChatroom *)  aChatroom reason: ("Use -didDismissFromChatroom:reason: instead")  __deprecated_msg

optional

User was kicked out from the chatroom.

Deprecated, please use didDismissFromChatroom:reason: instead.

Parameters

aChatroom	The chatroom which the user was kicked out from.
aReason	The reason of kicked out.

didReceiveUserJoinedChatroom:username:

- (void) didReceiveUserJoinedChatroom: (AgoraChatroom *)  aChatroom username: ("Use -userDidJoinChatroom:user: instead")  __deprecated_msg

optional

Occurs when a user joins a chat room

Deprecated, please use userDidJoinChatroom:user: instead.

Parameters

aChatroom	Joined chatroom
aUsername	The user who joined chatroom

didReceiveUserLeavedChatroom:username:

- (void) didReceiveUserLeavedChatroom: (AgoraChatroom *)  aChatroom username: ("Use -userDidLeaveChatroom:reason: instead")  __deprecated_msg

optional

A user leaved the chatroom.

Deprecated, please use userDidLeaveChatroom:reason: instead.

Parameters

aChatroom	The chatroom which the user Leaved from.
aUsername	The user who leaved chatroom.

userDidJoinChatroom:user:

- (void) userDidJoinChatroom: (AgoraChatroom *)  aChatroom user: (NSString *)  aUsername

optional

A user joined a chatroom.

Parameters

aChatroom	The chatroom user joined.
aUsername	The user who joined chatroom.

userDidLeaveChatroom:user:

- (void) userDidLeaveChatroom: (AgoraChatroom *)  aChatroom user: (NSString *)  aUsername

optional

Occurs when a user leaves a chatroom.

Parameters

aChatroom	The chatroom user left.
aUsername	The user who leaved chatroom

---

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

• AgoraChat.framework/Headers/AgoraChatroomManagerDelegate.h