<IAgoraChatroomManager> Protocol Reference

#import <IAgoraChatroomManager.h>

Inheritance diagram for <IAgoraChatroomManager>:

Instance Methods
(void)	- addDelegate:delegateQueue:
(void)	- removeDelegate:
(AgoraPageResult *)	- getChatroomsFromServerWithPage:pageSize:error:
(void)	- getChatroomsFromServerWithPage:pageSize:completion:
(AgoraChatroom *)	- createChatroomWithSubject:description:invitees:message:maxMembersCount:error:
(void)	- createChatroomWithSubject:description:invitees:message:maxMembersCount:completion:
(AgoraChatroom *)	- joinChatroom:error:
(void)	- joinChatroom:completion:
(void)	- leaveChatroom:error:
(void)	- leaveChatroom:completion:
(AgoraError *)	- destroyChatroom:
(void)	- destroyChatroom:completion:
(AgoraChatroom *)	- getChatroomSpecificationFromServerWithId:error:
(void)	- getChatroomSpecificationFromServerWithId:completion:
(AgoraCursorResult *)	- getChatroomMemberListFromServerWithId:cursor:pageSize:error:
(void)	- getChatroomMemberListFromServerWithId:cursor:pageSize:completion:
(NSArray *)	- getChatroomBlacklistFromServerWithId:pageNumber:pageSize:error:
(void)	- getChatroomBlacklistFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getChatroomMuteListFromServerWithId:pageNumber:pageSize:error:
(void)	- getChatroomMuteListFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getChatroomWhiteListFromServerWithId:error:
(void)	- getChatroomWhiteListFromServerWithId:completion:
(BOOL)	- isMemberInWhiteListFromServerWithChatroomId:error:
(void)	- isMemberInWhiteListFromServerWithChatroomId:completion:
(NSString *)	- getChatroomAnnouncementWithId:error:
(void)	- getChatroomAnnouncementWithId:completion:
(AgoraChatroom *)	- updateSubject:forChatroom:error:
(void)	- updateSubject:forChatroom:completion:
(AgoraChatroom *)	- updateDescription:forChatroom:error:
(void)	- updateDescription:forChatroom:completion:
(AgoraChatroom *)	- removeMembers:fromChatroom:error:
(void)	- removeMembers:fromChatroom:completion:
(AgoraChatroom *)	- blockMembers:fromChatroom:error:
(void)	- blockMembers:fromChatroom:completion:
(AgoraChatroom *)	- unblockMembers:fromChatroom:error:
(void)	- unblockMembers:fromChatroom:completion:
(AgoraChatroom *)	- updateChatroomOwner:newOwner:error:
(void)	- updateChatroomOwner:newOwner:completion:
(AgoraChatroom *)	- addAdmin:toChatroom:error:
(void)	- addAdmin:toChatroom:completion:
(AgoraChatroom *)	- removeAdmin:fromChatroom:error:
(void)	- removeAdmin:fromChatroom:completion:
(AgoraChatroom *)	- muteMembers:muteMilliseconds:fromChatroom:error:
(void)	- muteMembers:muteMilliseconds:fromChatroom:completion:
(AgoraChatroom *)	- unmuteMembers:fromChatroom:error:
(void)	- unmuteMembers:fromChatroom:completion:
(AgoraChatroom *)	- muteAllMembersFromChatroom:error:
(void)	- muteAllMembersFromChatroom:completion:
(AgoraChatroom *)	- unmuteAllMembersFromChatroom:error:
(void)	- unmuteAllMembersFromChatroom:completion:
(AgoraChatroom *)	- addWhiteListMembers:fromChatroom:error:
(void)	- addWhiteListMembers:fromChatroom:completion:
(AgoraChatroom *)	- removeWhiteListMembers:fromChatroom:error:
(void)	- removeWhiteListMembers:fromChatroom:completion:
(AgoraChatroom *)	- updateChatroomAnnouncementWithId:announcement:error:
(void)	- updateChatroomAnnouncementWithId:announcement:completion:
(AgoraChatroom *)	- fetchChatroomInfo:includeMembersList:error:
(void)	- getChatroomSpecificationFromServerByID:includeMembersList:completion:
(void)	- addDelegate:
(NSArray *)	- getAllChatroomsFromServerWithError:
(void)	- getAllChatroomsFromServerWithCompletion:
(void)	- asyncGetAllChatroomsFromServer:failure:
(void)	- asyncJoinChatroom:success:failure:
(void)	- asyncLeaveChatroom:success:failure:
(void)	- asyncFetchChatroomInfo:includeMembersList:success:failure:

Detailed Description

Chatroom operations

Method Documentation

- (void) addAdmin: (NSString *)  aAdmin toChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroomp, AgoraError *aError))  aCompletionBlock

required

Add chatroom admin, need Owner permissions

Parameters

aAdmin	Admin
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) addAdmin: (NSString *)  aAdmin toChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Add chatroom admin, need Owner permissions

Synchronization method will block the current thread

Parameters

aAdmin	Admin
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) addDelegate: (3_1_0)  (3_2_2)  ("Use - instead")  EM_DEPRECATED_IOS[IAgoraChatroomManager addDelegate:delegateQueue:]

required

Add delegate

Parameters

aDelegate

Delegate

- (void) addDelegate: (id< AgoraChatroomManagerDelegate >)  aDelegate delegateQueue: (dispatch_queue_t)  aQueue

required

Add delegate

Parameters

aDelegate	Delegate to be added
aQueue	(optional) The queue of calling delegate methods. Pass in nil to run on main thread.

- (void) addWhiteListMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

add white list members, need Owner / Admin permissions

Parameters

aMembers	The list of whitelist, type is <NSString>
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) addWhiteListMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

add white list members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The list of whitelist, type is <NSString>
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) asyncFetchChatroomInfo: (NSString *)  aChatroomId includeMembersList: (BOOL)  aIncludeMembersList success: (void(^)(AgoraChatroom *aChatroom))  aSuccessBlock failure: ("Use -getChatroomSpecificationFromServerByID:includeMembersList:completion: instead")  __deprecated_msg

required

Fetch chatroom's specification

Parameters

aChatroomId	Chatroom id
aIncludeMembersList	Whether get member list
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncGetAllChatroomsFromServer: (void(^)(NSArray *aList))  aSuccessBlock failure: ("Use -getAllChatroomsFromServerWithCompletion: instead")  __deprecated_msg

required

Get all the chatrooms from server

Parameters

aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncJoinChatroom: (NSString *)  aChatroomId success: (void(^)(AgoraChatroom *aRoom))  aSuccessBlock failure: ("Use -joinChatroom:completion: instead")  __deprecated_msg

required

Join a chatroom

Parameters

aChatroomId	Chatroom id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncLeaveChatroom: (NSString *)  aChatroomId success: (void(^)(AgoraChatroom *aRoom))  aSuccessBlock failure: ("Use -leaveChatroom:completion: instead")  __deprecated_msg

required

Leave a chatroom

Parameters

aChatroomId	Chatroom id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

Returns

Leaved chatroom

- (void) blockMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Add users to chatroom blacklist, owner‘s authority is required

Parameters

aMembers	Users to be added
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) blockMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Add users to chatroom blacklist, required owner‘s authority

Synchronization method will block the current thread

Parameters

aMembers	Users to be added
aChatroomId	Chatroom id
pError	Error

Returns

Chatroom instance

- (void) createChatroomWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage maxMembersCount: (NSInteger)  aMaxMembersCount completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Create a chatroom

Parameters

aSubject	Group subject
aDescription	Group description
aInvitees	Group members, without creater
aMessage	Invitation message
aMaxMembersCount	Max members count
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) createChatroomWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage maxMembersCount: (NSInteger)  aMaxMembersCount error: (AgoraError **)  pError

required

Create a chatroom

Synchronization method will block the current thread

Parameters

aSubject	Subject
aDescription	Description
aInvitees	Members, without creater
aMessage	Invitation message
aMaxMembersCount	Max members count
pError	Error

Returns

AgoraChatroom Created chatroom

- (AgoraError *) destroyChatroom: (NSString *)  aChatroomId

required

Destroy a group, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aChatroomId

Chatroom id

Returns

AgoraError Error, return nil if success

- (void) destroyChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraError *aError))  aCompletionBlock

required

Destroy a group, owner‘s authority is required

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) fetchChatroomInfo: (NSString *)  aChatroomId includeMembersList: (BOOL)  aIncludeMembersList error: (3_1_0)  (3_3_0)  ("Use - instead")  EM_DEPRECATED_IOS[IAgoraChatroomManager getChatroomSpecificationFromServerWithId:error:]

required

Fetch chatroom's specification

Synchronization method, will block the current thread

Parameters

aChatroomId	Chatroom id
aIncludeMembersList	Whether to get member list，When YES, returns 200 members
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) getAllChatroomsFromServerWithCompletion: ("Use -getChatroomsFromServerWithPage instead")  __deprecated_msg

required

Get all the chatrooms from server

Parameters

aCompletionBlock

The callback block of completion

- (NSArray *) getAllChatroomsFromServerWithError: ("Use -getChatroomsFromServerWithPage instead")  __deprecated_msg

required

Get all the chatrooms from server

Synchronization method will block the current thread

Parameters

pError

Error

Returns

Chat room NSArray<AgoraChatroom>

- (void) getChatroomAnnouncementWithId: (NSString *)  aChatroomId completion: (void(^)(NSString *aAnnouncement, AgoraError *aError))  aCompletionBlock

required

Get the announcement of chatroom from the server

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (NSString *) getChatroomAnnouncementWithId: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Get the announcement of chatroom from the server

Parameters

aChatroomId	Chatroom id
pError	error

Returns

The announcement of chatroom

- (void) getChatroomBlacklistFromServerWithId: (NSString *)  aChatroomId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get chatroom's blacklist, need owner / admin permissions

Parameters

aChatroomId	Chatroom id
aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (NSArray *) getChatroomBlacklistFromServerWithId: (NSString *)  aChatroomId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the blacklist of chatroom from the server, need owner / admin permissions

Parameters

aChatroomId	Chatroom id
aPageNum	Page number
aPageSize	Page size
pError	Error

- (void) getChatroomMemberListFromServerWithId: (NSString *)  aChatroomId cursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize completion: (void(^)(AgoraCursorResult *aResult, AgoraError *aError))  aCompletionBlock

required

Get the list of chatroom members from the server

Parameters

aChatroomId	Chatroom id
aCursor	Cursor, input nil the first time
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (AgoraCursorResult *) getChatroomMemberListFromServerWithId: (NSString *)  aChatroomId cursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the list of chatroom members from the server

Parameters

aChatroomId	Chatroom id
aCursor	Cursor, input nil the first time
aPageSize	Page size
pError	Error

Returns

List and cursor

- (void) getChatroomMuteListFromServerWithId: (NSString *)  aChatroomId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get the mutes of chatroom from the server

Parameters

aChatroomId	Chatroom id
aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (NSArray *) getChatroomMuteListFromServerWithId: (NSString *)  aChatroomId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the mutes of chatroom from the server

Parameters

aChatroomId	Chatroom id
aPageNum	Page number
aPageSize	Page size
pError	Error

- (void) getChatroomsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(AgoraPageResult *aResult, AgoraError *aError))  aCompletionBlock

required

Get all the chatrooms from server

Parameters

aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (AgoraPageResult *) getChatroomsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get pagesize number chatroom from server.

Synchronization method will block the current thread

Parameters

aPageNum	Page number
aPageSize	Page size
pError	Error

Returns

AgoraPageResult Chatroom list is in the object's list

- (void) getChatroomSpecificationFromServerByID: (NSString *)  aChatroomId includeMembersList: (BOOL)  aIncludeMembersList completion: (3_1_0)  (3_3_0)  ("Use - instead")  EM_DEPRECATED_IOS[IAgoraChatroomManager getChatroomSpecificationFromServerWithId:completion:]

required

Fetch chat room specifications

Parameters

aChatroomId	Chatroom id
aIncludeMembersList	Whether to get member list，When YES, returns 200 members
aCompletionBlock	The callback block of completion

- (void) getChatroomSpecificationFromServerWithId: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Fetch chat room specifications

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) getChatroomSpecificationFromServerWithId: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Fetch chatroom's specification

Synchronization method, will block the current thread

Parameters

aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) getChatroomWhiteListFromServerWithId: (NSString *)  aChatroomId completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get the whitelist of chatroom from the server

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (NSArray *) getChatroomWhiteListFromServerWithId: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Get the whitelist of chatroom from the server

Parameters

aChatroomId	Chatroom id
pError	Error

- (void) isMemberInWhiteListFromServerWithChatroomId: (NSString *)  aChatroomId completion: (void(^)(BOOL inWhiteList, AgoraError *aError))  aCompletionBlock

required

Gets whether the member is on the whitelist

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (BOOL) isMemberInWhiteListFromServerWithChatroomId: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Gets whether the member is on the whitelist

Parameters

aChatroomId	Chatroom id
pError	Error

- (void) joinChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Join a chatroom

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) joinChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Join a chatroom

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Joined chatroom

- (void) leaveChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraError *aError))  aCompletionBlock

required

Leave a chatroom

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (void) leaveChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Leave a chatroom

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
pError	Error

- (void) muteAllMembersFromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

mute all members, need Owner / Admin permissions

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) muteAllMembersFromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

mute all members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) muteMembers: (NSArray *)  aMuteMembers muteMilliseconds: (NSInteger)  aMuteMilliseconds fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Mute chatroom members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMuteMembers	The list of mute, type is <NSString>
aMuteMilliseconds	Muted time duration in millisecond
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) muteMembers: (NSArray *)  aMuteMembers muteMilliseconds: (NSInteger)  aMuteMilliseconds fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Mute chatroom members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMuteMembers	The list of mute, type is <NSString>
aMuteMilliseconds	Muted time duration in millisecond
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) removeAdmin: (NSString *)  aAdmin fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Remove chatroom admin, need Owner permissions

Parameters

aAdmin	Admin
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) removeAdmin: (NSString *)  aAdmin fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Remove chatroom admin, need Owner permissions

Synchronization method will block the current thread

Parameters

aAdmin	Admin
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) removeDelegate: (id< AgoraChatroomManagerDelegate >)  aDelegate

required

Remove delegate

Parameters

aDelegate

Delegate to be removed

- (void) removeMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Remove members from a group, owner‘s authority is required

Parameters

aMembers	Users to be removed
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) removeMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Remove members from a chatroom, required owner‘s authority

Synchronization method will block the current thread

Parameters

aMembers	Users to be removed
aChatroomId	Chatroom id
pError	Error

Returns

Chatroom instance

- (void) removeWhiteListMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

remove white list members, need Owner / Admin permissions

Parameters

aMembers	The remove list of whitelist, type is <NSString>
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) removeWhiteListMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

remove white list members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The remove list of whitelist, type is <NSString>
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) unblockMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Remove users from chatroom blacklist, owner‘s authority is required

Parameters

aMembers	Users to be removed
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) unblockMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Remove users from chatroom blacklist, required owner‘s authority

Synchronization method will block the current thread

Parameters

aMembers	Users to be removed
aChatroomId	Chatroom id
pError	Error

Returns

Chatroom instance

- (void) unmuteAllMembersFromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

unmute all members, need Owner / Admin permissions

Parameters

aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) unmuteAllMembersFromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

unmute all members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) unmuteMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Unmute chatroom members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The list of unmute, type is <NSString>
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) unmuteMembers: (NSArray *)  aMembers fromChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Unmute chatroom members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The list of unmute, type is <NSString>
aChatroomId	Chatroom id
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) updateChatroomAnnouncementWithId: (NSString *)  aChatroomId announcement: (NSString *)  aAnnouncement completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Change the announcement of chatroom, need Owner / Admin permissions

Parameters

aChatroomId	Chatroom id
aAnnouncement	announcement of chatroom
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) updateChatroomAnnouncementWithId: (NSString *)  aChatroomId announcement: (NSString *)  aAnnouncement error: (AgoraError **)  pError

required

Change the announcement of chatroom, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
aAnnouncement	announcement of chatroom
pError	error

Returns

AgoraChatroom Chatroom instance

- (void) updateChatroomOwner: (NSString *)  aChatroomId newOwner: (NSString *)  aNewOwner completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Change chatroom owner, need Owner permissions

Parameters

aChatroomId	Chatroom id
aNewOwner	New owner
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) updateChatroomOwner: (NSString *)  aChatroomId newOwner: (NSString *)  aNewOwner error: (AgoraError **)  pError

required

Change chatroom owner, need Owner permissions

Synchronization method will block the current thread

Parameters

aChatroomId	Chatroom id
aNewOwner	New owner
pError	Error

Returns

AgoraChatroom Chatroom instance

- (void) updateDescription: (NSString *)  aDescription forChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Change the chatroom description, owner‘s authority is required

Parameters

aDescription	New description
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) updateDescription: (NSString *)  aDescription forChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Change chatroom description, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aDescription	New description
aChatroomId	Chatroom id
pError	Error

Returns

Chatroom

- (void) updateSubject: (NSString *)  aSubject forChatroom: (NSString *)  aChatroomId completion: (void(^)(AgoraChatroom *aChatroom, AgoraError *aError))  aCompletionBlock

required

Change the chatroom subject, owner‘s authority is required

Parameters

aSubject	New subject
aChatroomId	Chatroom id
aCompletionBlock	The callback block of completion

- (AgoraChatroom *) updateSubject: (NSString *)  aSubject forChatroom: (NSString *)  aChatroomId error: (AgoraError **)  pError

required

Change chatroom subject, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aSubject	New subject
aChatroomId	Chatroom id
pError	Error

Returns

Chatroom instance

---

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

• AgoraChat.framework/Headers/IAgoraChatroomManager.h