AgoraChatSDK 1.0.7
|
#import <IAgoraChatroomManager.h>
A class that manages the chatrooms.
|
required |
Adds a chatroom admin.
Only the chatroom owner can call this method.
This is an asynchronous method.
aAdmin | The new admin. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Adds a chatroom admin.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aAdmin | The new admin. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Adds the SDK delegate.
aDelegate | The delegate that you want to add: ChatroomManagerDelegate. |
aQueue | (Optional) The queue of calling the delegate methods. To run the app on the main thread, set this parameter as nil. |
|
required |
Adds members to the allowlist.
Only the chatroom owner and admin can call this method.
This is an asynchronous method.
aMembers | The members to be added to the allowlist. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Adds users to the allowlist.
Only the chatroom owner and admin can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The members to be added to the allowlist. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Adds users to the chatroom's blocklist.
Only the chatroom owner can call this method.
This is an asynchronous method.
aMembers | The users to be added to the chatroom. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Adds users to the chatroom's blocklist.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The users to be added to the blocklist. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Creates a chatroom.
This is an asynchronous method.
aSubject | The subject of the chatroom. |
aDescription | The description of the chatroom. |
aInvitees | The members of the chatroom. Do not include the creator. |
aMessage | The invitation message. |
aMaxMembersCount | The maximum number of members in the chatroom. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Creates a chatroom.
This is a synchronous method and blocks the current thread.
aSubject | The subject of the chatroom. |
aDescription | The description of the chatroom. |
aInvitees | The members of the chatroom. Do not include the creator. |
aMessage | The invitation message. |
aMaxMembersCount | The maximum number of members in the chatroom. |
pError | The error information if the method fails: Error. |
|
required |
Dismisses a chatroom.
Only the owner of a chatroom has the privilege to dismiss it.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
nil
if the method call succeeds.
|
required |
Dismisses a chatroom.
Only the owner of a chatroom has the privilege to dismiss it.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the announcement of a chatroom from the server.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the announcement of a chatroom from the server.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Gets the chatroom's blocklist.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aPageNum | The page number. |
aPageSize | The page size. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the blocklist of chatroom from the server.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
aPageNum | The page number. |
aPageSize | The page size. |
pError | The error information if the method fails: Error. |
|
required |
Gets the list of chatroom members from the server.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCursor | The cursor. Set this parameter as nil when you call this method for the first time. |
aPageSize | The page size. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the list of chatroom members from the server.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
aCursor | The cursor. Set this parameter as nil when you call this method for the first time. |
aPageSize | The page size. |
pError | The error information if the method fails: Error. |
|
required |
Gets the list of members who were muted in the chatroom from the server.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aPageNum | The page number. |
aPageSize | The page size. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the list of members who are muted in the chatroom from the server.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
aPageNum | The page number. |
aPageSize | The page size. |
pError | The error information if the method fails: Error. |
|
required |
Gets the specified number of chat rooms from the server.
This is an asynchronous method.
aPageNum | The page number. |
aPageSize | The page size. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the specified number of chat rooms from the server.
This is a synchronous method and blocks the current thread.
aPageNum | The page number. |
aPageSize | The page size. |
pError | The error information if the method fails: Error. |
|
required |
Fetches the chat room specifications.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Fetches the specific chatroom.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Fetches the chat room specifications.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aFetchMembers | Whether to get the member list. If you set the parameter as YES, it will return no more than 200 members. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the allowlist of a chatroom from the server.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Gets the allowlist of a chatroom from the server.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Checks whether the current user is on the allowlist.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Checks whether the current user is on the allowlist.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Joins a chatroom.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Joins a chatroom.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Leaves a chatroom.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Leaves a chatroom.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Mutes all members.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Mutes all members.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Mutes chatroom members.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aMuteMembers | The list of mute. |
aMuteMilliseconds | Muted time duration in millisecond |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Mutes chatroom members.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aMuteMembers | The list of members to mute. |
aMuteMilliseconds | Muted time duration in millisecond. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Removes a chatroom admin.
Only the chatroom owner and admin can call this method.
This is an asynchronous method.
aAdmin | The admin to be removed. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Removes a chatroom admin.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aAdmin | The admin to be removed. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Removes the delegate.
aDelegate | The delegate that you want to remove. |
|
required |
Removes members from a chatroom.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aMembers | The users to be removed from the chatroom. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Removes members from a chatroom.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The users to be removed from the chatroom. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Removes members from the allowlist.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aMembers | The members to be removed from the allowlist. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Removes the members of the allowlist.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The members to be removed from the allowlist. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Removes users from the chatroom blocklist.
Only the chatroom owner can call this method.
This is an asynchronous method.
aMembers | The users to be removed from the blocklist. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Removes users from chatroom blocklist.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The users to be removed from the blocklist. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Unmute all members.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Unmute all members.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Unmutes chatroom members.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aMembers | The list of unmute. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Unmutes chatroom members.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aMembers | The list of members to unmute. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Changes the announcement of chatroom.
Only the chatroom owner or admin can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aAnnouncement | The announcement of the chatroom. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Changes the announcement of the chatroom.
Only the chatroom owner or admin can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
aAnnouncement | The announcement of the chatroom. |
pError | The error information if the method fails: Error. |
|
required |
Changes the chatroom owner.
Only the chatroom owner can call this method.
This is an asynchronous method.
aChatroomId | The chatroom ID. |
aNewOwner | The new owner. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Changes the chatroom owner.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aChatroomId | The chatroom ID. |
aNewOwner | The new owner. |
pError | The error information if the method fails: Error. |
|
required |
Changes the chatroom's description.
Only the chatroom owner can call this method.
This is an asynchronous method.
aDescription | The new description. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Changes chatroom description.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aDescription | The new description. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |
|
required |
Changes the chatroom subject.
Only the chatroom owner can call this method.
This is an asynchronous method.
aSubject | The new subject of the chatroom. |
aChatroomId | The chatroom ID. |
aCompletionBlock | The completion block, which contains the error message if the method call fails. |
|
required |
Changes the chatroom‘s subject.
Only the chatroom owner can call this method.
This is a synchronous method and blocks the current thread.
aSubject | The new subject of the chatroom. |
aChatroomId | The chatroom ID. |
pError | The error information if the method fails: Error. |