Chatroom | Agora Chat SDK API Reference

Chatroom contains APIs for chatroom-related operations.

Functions

addUsersToChatRoomAllowlist

addUsersToChatRoomAllowlist(this: any, params: { chatRoomId: string; users: string[]; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>>

Adds members to the allow list of the chat room. Members added to the allow list of the chat room will receive in onChatroomEvent callback operation: 'addUserToAllowlist'.
```
connection.addUsersToChatRoomAllowlist({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; users: string[]; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - users: string[]
    
    The members to be added to the allow list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>>

blockChatRoomMember

blockChatRoomMember(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

Adds a member to the the block list of the chat room. Only the chat room owner or admin can call this method.
```
connection.blockChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The member to be added to the block list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

blockChatRoomMembers

blockChatRoomMembers(this: any, params: { chatRoomId: string; usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult[]>>

Adds members to the block list of the chat room. Only the chat room owner or admin can call this method.
```
connection.blockChatRoomMembers({usernames: ['user1', 'user2'], chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; usernames: string[]; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - usernames: string[]
    
    The members to be added to the block list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult[]>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult[]>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult[]>>

createChatRoom

createChatRoom(this: any, params: { description: string; maxusers: number; members?: string[]; name: string; token?: string; error?: any; success?: any }): Promise<AsyncResult<CreateChatRoomResult>>

Creates a chat room.
```
connection.createChatRoom({name: 'myChatRoom', description: 'this is my chatroom', maxusers: 200, members: ['user1'], token: 'your token'})
```
Parameters
- this: any
- params: { description: string; maxusers: number; members?: string[]; name: string; token?: string; error?: any; success?: any }
  - description: string
    
    The description of the chat room.
  - maxusers: number
    
    The maximum number of members in the chat room, including the chat room creator. The value is an integer in the range of [1,5000], with 200 as the default.
  - Optional members?: string[]
    
    (Optional) The members in the chat room. An array of user IDs of members. If you set this parameter, ensure that the array contains at least one user ID.
  - name: string
    
    The chat room name.
  - Optional token?: string
    
    The super admin token.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CreateChatRoomResult>): void
    - Parameters
      - res: AsyncResult<CreateChatRoomResult>
      Returns void
Returns Promise<AsyncResult<CreateChatRoomResult>>

deleteChatRoomSharedFile

deleteChatRoomSharedFile(this: any, params: { fileId: string; roomId: string; error?: any; success?: any }): Promise<AsyncResult<DeleteChatRoomSharedFileResult>>

Deletes a shared file of the chat room.
```
connection.deleteChatRoomSharedFile({roomId: 'roomId', fileId: 'fileId'})
```
Parameters
- this: any
- params: { fileId: string; roomId: string; error?: any; success?: any }
  - fileId: string
    
    The shared file ID.
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<DeleteChatRoomSharedFileResult>): void
    - Parameters
      - res: AsyncResult<DeleteChatRoomSharedFileResult>
      Returns void
Returns Promise<AsyncResult<DeleteChatRoomSharedFileResult>>

destroyChatRoom

destroyChatRoom(this: any, params: { chatRoomId: string; token: string; error?: any; success?: any }): Promise<AsyncResult<CreateChatRoomResult>>

Destroys the chat room.
```
connection.destroyChatRoom({chatRoomId: 'chatRoomId', token: 'your token'})
```
Parameters
- this: any
- params: { chatRoomId: string; token: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID
  - token: string
    
    The super admin token.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CreateChatRoomResult>): void
    - Parameters
      - res: AsyncResult<CreateChatRoomResult>
      Returns void
Returns Promise<AsyncResult<CreateChatRoomResult>>

disableSendChatRoomMsg

disableSendChatRoomMsg(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<WhetherAbleSendChatRoomMsgResult>>

Mutes all the members in the chat room. Only the chat room owner or admin can call this method. Chat room members will receive the muteAllMembers event.
```
connection.disableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<WhetherAbleSendChatRoomMsgResult>): void
    - Parameters
      - res: AsyncResult<WhetherAbleSendChatRoomMsgResult>
      Returns void
Returns Promise<AsyncResult<WhetherAbleSendChatRoomMsgResult>>

enableSendChatRoomMsg

enableSendChatRoomMsg(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<WhetherAbleSendChatRoomMsgResult>>

Unmutes all the members in the chat room.
Only the chat room owner or admin can call this method.

The chat room members will receive the unmuteAllMembers event.
```
connection.enableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<WhetherAbleSendChatRoomMsgResult>): void
    - Parameters
      - res: AsyncResult<WhetherAbleSendChatRoomMsgResult>
      Returns void
Returns Promise<AsyncResult<WhetherAbleSendChatRoomMsgResult>>

fetchChatRoomAnnouncement

fetchChatRoomAnnouncement(this: any, params: { roomId: string; error?: any; success?: any }): Promise<AsyncResult<FetchChatRoomAnnouncementResult>>

Gets the announcement of the chat room.
```
connection.fetchChatRoomAnnouncement({roomId: 'roomId'})
```
Parameters
- this: any
- params: { roomId: string; error?: any; success?: any }
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<FetchChatRoomAnnouncementResult>): void
    - Parameters
      - res: AsyncResult<FetchChatRoomAnnouncementResult>
      Returns void
Returns Promise<AsyncResult<FetchChatRoomAnnouncementResult>>

getChatRoomAdmin

getChatRoomAdmin(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<GetChatRoomAdminResult>>

Gets all admins of the chat room.
```
connection.getChatRoomAdmin({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetChatRoomAdminResult>): void
    - Parameters
      - res: AsyncResult<GetChatRoomAdminResult>
      Returns void
Returns Promise<AsyncResult<GetChatRoomAdminResult>>

getChatRoomAllowlist

getChatRoomAllowlist(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

Gets the allow list of the chat room.
Only the chat room owner or admin can call this method.
```
connection.getChatRoomWhitelist({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<string[]>): void
    - Parameters
      - res: AsyncResult<string[]>
      Returns void
Returns Promise<AsyncResult<UserId[]>>

getChatRoomAttributes

getChatRoomAttributes(this: any, params: { attributeKeys?: string[]; chatRoomId: string }): Promise<AsyncResult<GetChatroomAttributesResult>>

Gets all of the chat room custom attributes.
```
connection.getChatRoomAttributes({chatRoomId: 'chatRoomId', attributes:["attributeKey1","attributeKey2"]})
```
Parameters
- this: any
- params: { attributeKeys?: string[]; chatRoomId: string }
  - Optional attributeKeys?: string[]
    
    The custom attribute to get. If you pass the attribute key, the SDK returns the attribute value. If you set it as null, the SDK returns all the attributes value.
  - chatRoomId: string
    
    The chat room ID.
Returns Promise<AsyncResult<GetChatroomAttributesResult>>

getChatRoomBlocklist

getChatRoomBlocklist(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

Gets the block list of the chat room.
```
connection.getChatRoomBlocklist({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<string[]>): void
    - Parameters
      - res: AsyncResult<string[]>
      Returns void
Returns Promise<AsyncResult<UserId[]>>

getChatRoomDetails

getChatRoomDetails(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<GetChatRoomDetailsResult[]>>

Gets specifications of the chat room.
```
connection.getChatRoomDetails({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetChatRoomDetailsResult[]>): void
    - Parameters
      - res: AsyncResult<GetChatRoomDetailsResult[]>
      Returns void
Returns Promise<AsyncResult<GetChatRoomDetailsResult[]>>

getChatRoomMembers

getChatRoomMembers(this: Connection, params: { chatRoomId: string; cursor?: string; limit?: number }): Promise<AsyncResult<{ cursor: string | undefined; members: FetchedGroupMember[] }>>

Gets the list chat room members with pagination.
```
connection.getChatRoomMembers({cursor: '', limit: 50, chatRoomId: 'chatRoomId'})
```
Parameters
- this: Connection
- params: { chatRoomId: string; cursor?: string; limit?: number }
  - chatRoomId: string
    
    The chat room ID.
  - Optional cursor?: string
    
    The cursor that specifies where to start to get data. If there will be data on the next page, this method will return the value of this field to indicate the position to start to get data of the next page. If it is null, the data of the first page will be fetched.
  - Optional limit?: number
    
    The number of members retrieved per page. The value range is [1,50], with 50 as the default.
Returns Promise<AsyncResult<{ cursor: string | undefined; members: FetchedGroupMember[] }>>

getChatRoomMutelist

getChatRoomMutelist(this: any, params: { chatRoomId: string; error?: any; success?: any }): Promise<AsyncResult<GetChatRoomMuteListResult[]>>

Gets all muted members in the chat room.
```
connection.getChatRoomMutelist({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetChatRoomMuteListResult[]>): void
    - Parameters
      - res: AsyncResult<GetChatRoomMuteListResult[]>
      Returns void
Returns Promise<AsyncResult<GetChatRoomMuteListResult[]>>

getChatRoomSharedFilelist

getChatRoomSharedFilelist(this: any, params: { roomId: string; error?: any; success?: any }): Promise<AsyncResult<FetchChatRoomSharedFileListResult[]>>

Gets the list of shared files in the chat room.
```
connection.getChatRoomSharedFilelist({roomId: 'roomId'})
```
Parameters
- this: any
- params: { roomId: string; error?: any; success?: any }
  - roomId: string
    
    The chat room ID
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<FetchChatRoomSharedFileListResult[]>): void
    - Parameters
      - res: AsyncResult<FetchChatRoomSharedFileListResult[]>
      Returns void
Returns Promise<AsyncResult<FetchChatRoomSharedFileListResult[]>>

getChatRooms

getChatRooms(this: any, params: { pagenum: number; pagesize: number; error?: any; success?: any }): Promise<AsyncResult<GetChatRoomsResult>>

Gets the chat room list with pagination.
```
connection.getChatRooms({pagenum: 1, pagesize: 20})
```
Parameters
- this: any
- params: { pagenum: number; pagesize: number; error?: any; success?: any }
  - pagenum: number
    
    The page number, starting from 1.
  - pagesize: number
    
    The number of chat rooms that you expect to get on each page. The default value is 20.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetChatRoomsResult>): void
    - Parameters
      - res: AsyncResult<GetChatRoomsResult>
      Returns void
Returns Promise<AsyncResult<GetChatRoomsResult>>

getJoinedChatRooms

getJoinedChatRooms(this: Connection, params: { pageNum: number; pageSize: number }): Promise<AsyncResult<JoinedChatRoomsResult>>

Gets the list of chat rooms that a user has joined.
```
connection.getJoinedChatRooms({pageNum: 1, pageSize: 20})
```
Parameters
- this: Connection
- params: { pageNum: number; pageSize: number }
  - pageNum: number
    
    The page number, starting from 1.
  - pageSize: number
    
    The number of chat rooms to get per page. The value cannot exceed 500.
Returns Promise<AsyncResult<JoinedChatRoomsResult>>

isInChatRoomAllowlist

isInChatRoomAllowlist(this: any, params: { chatRoomId: string; userName: string; error?: any; success?: any }): Promise<AsyncResult<IsChatRoomWhiteUserResult>>

Checks whether chat room members are on the allow list.
Only the chat room owner or admin can call this method. The chat room members can check themselves.
```
connection.isInChatRoomAllowlist({chatRoomId: 'chatRoomId', userName: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; userName: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - userName: string
    
    The member ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<IsChatRoomWhiteUserResult>): void
    - Parameters
      - res: AsyncResult<IsChatRoomWhiteUserResult>
      Returns void
Returns Promise<AsyncResult<IsChatRoomWhiteUserResult>>

isInChatRoomMutelist

isInChatRoomMutelist(this: any, params: { chatRoomId: string }): Promise<AsyncResult<boolean>>

Check whether you are on the chat room mute list.
```
connection.isInChatRoomMutelist({chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string }
  - chatRoomId: string
    
    The chat room ID.
Returns Promise<AsyncResult<boolean>>

joinChatRoom

joinChatRoom(this: any, params: { ext?: string; leaveOtherRooms?: boolean; message?: string; roomId: string; error?: any; success?: any }): Promise<AsyncResult<JoinChatRoomResult>>

Joins the chat room.
note
After a user joins successfully, other members in the chat room will receive operation: 'memberPresence' in the onChatroomEvent callback.
```
connection.joinChatRoom({roomId: 'roomId'})
```
Parameters
- this: any
- params: { ext?: string; leaveOtherRooms?: boolean; message?: string; roomId: string; error?: any; success?: any }
  - Optional ext?: string
    
    Extension fields carried when joining a chat room.
  - Optional leaveOtherRooms?: boolean
    Whether to leave all the currently joined chat rooms when joining a chat room.
    
    true: The user joins the chat room, while leaving all other chat rooms.
    
    (Default) false: The user joins the chat room, without leaving all other chat rooms.
  - Optional message?: string
    
    The reason for joining the chat room. This parameter does not take effect. You can ignore it.
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<JoinChatRoomResult>): void
    - Parameters
      - res: AsyncResult<JoinChatRoomResult>
      Returns void
Returns Promise<AsyncResult<JoinChatRoomResult>>

leaveChatRoom

leaveChatRoom(this: any, params: { roomId: string; error?: any; success?: any }): Promise<AsyncResult<{ result: boolean }>>

Exits the chat room.
note
When a member exits the chat room, other members will receive "operation: 'memberAbsence'" in the callback of onChatroomEvent.
```
connection.leaveChatRoom({roomId: 'roomId'})
```
Parameters
- this: any
- params: { roomId: string; error?: any; success?: any }
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<{ result: boolean }>): void
    - Parameters
      - res: AsyncResult<{ result: boolean }>
      Returns void
Returns Promise<AsyncResult<{ result: boolean }>>

listChatRoomMembers

listChatRoomMembers(this: any, params: { chatRoomId: string; pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<BaseMembers[]>>

Lists all chat room members with pagination.
deprecated
use getChatRoomMembers instead.
```
connection.listChatRoomMembers({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; pageNum: number; pageSize: number; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - pageNum: number
    
    The page number, starting from 1.
  - pageSize: number
    
    The number of members that you expect to get on each page. The value range is [1,1000].
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<BaseMembers[]>): void
    - Parameters
      - res: AsyncResult<BaseMembers[]>
      Returns void
Returns Promise<AsyncResult<BaseMembers[]>>

modifyChatRoom

modifyChatRoom(this: any, params: { chatRoomId: string; chatRoomName?: string; description?: string; maxusers?: number; error?: any; success?: any }): Promise<AsyncResult<ModifyChatRoomResult>>

Modifies the specifications of the chat room.
```
connection.modifyChatRoom({chatRoomId: 'chatRoomId', chatRoomName: 'chatRoomName', description: 'description', maxusers: 5000})
```
Parameters
- this: any
- params: { chatRoomId: string; chatRoomName?: string; description?: string; maxusers?: number; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - Optional chatRoomName?: string
    
    The chat room name.
  - Optional description?: string
    
    The description of the chat room.
  - Optional maxusers?: number
    
    The maximum number of members in the chat room.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ModifyChatRoomResult>): void
    - Parameters
      - res: AsyncResult<ModifyChatRoomResult>
      Returns void
Returns Promise<AsyncResult<ModifyChatRoomResult>>

muteChatRoomMember

muteChatRoomMember(this: any, params: { chatRoomId: string; muteDuration: number; username: string; error?: any; success?: any }): Promise<AsyncResult<MuteChatRoomMemberResult>>

Mutes chat room member.
note
Only the chat room owner or admins can call this method. The muted member and other admins will receive "operation:'muteMember'" in the callback of onChatroomEvent.
```
connection.muteChatRoomMember({username: 'user1', muteDuration: -1, chatRoomId: 'chatRoomId'})
```
Parameters
- this: any
- params: { chatRoomId: string; muteDuration: number; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - muteDuration: number
    
    The mute duration in milliseconds. The value -1 indicates that the member is muted permanently.
  - username: string
    
    The member to be muted in the chat room.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<MuteChatRoomMemberResult>): void
    - Parameters
      - res: AsyncResult<MuteChatRoomMemberResult>
      Returns void
Returns Promise<AsyncResult<MuteChatRoomMemberResult>>

removeChatRoomAdmin

removeChatRoomAdmin(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<RemoveChatRoomAdminResult>>

Removes chat room admins.
note
Only the chat room owner can call this method. The users whose admin privileges are removed will receive "operation: 'removeAdmin'" in the callback of onChatroomEvent.
```
connection.removeChatRoomAdmin({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The admins to be removed.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<RemoveChatRoomAdminResult>): void
    - Parameters
      - res: AsyncResult<RemoveChatRoomAdminResult>
      Returns void
Returns Promise<AsyncResult<RemoveChatRoomAdminResult>>

removeChatRoomAllowlistMember

removeChatRoomAllowlistMember(this: any, params: { chatRoomId: string; userName: string; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

Removes members from the allow list of the chat room. Only the chat room owner or admin can call this method. The users who are removed will receive "operation:'removeAllowlistMember'" in the callback of onChatroomEvent..
```
connection.removeChatRoomAllowlistMember({chatRoomId: 'chatRoomId', userName: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; userName: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - userName: string
    
    The members to be removed from the allow list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

removeChatRoomAttribute

removeChatRoomAttribute(this: any, params: { attributeKey: string; chatRoomId: string; isForced?: boolean }): Promise<void>

Removes a chat room attribute.
```
connection.removeChatRoomAttributes({chatRoomId: 'chatRoomId', attributeKeys: ['string1','string2'], isForced: boolean })
```
Parameters
- this: any
- params: { attributeKey: string; chatRoomId: string; isForced?: boolean }
  - attributeKey: string
    
    The key of the chat room attribute to delete.
  - chatRoomId: string
    
    The chat room ID.
  - Optional isForced?: boolean
    Whether to allow a member to overwrite any chat room attribute set by any member.
    
    true: Yes;
    
    (Default)false: No.
Returns Promise<void>

removeChatRoomAttributes

removeChatRoomAttributes(this: any, params: { attributeKeys: string[]; chatRoomId: string; isForced?: boolean }): Promise<AsyncResult<ChatroomAttributes>>

Removes custom chat room attributes.
```
connection.removeChatRoomAttributes({chatRoomId: 'chatRoomId', attributeKeys: ['attributeKey1','attributeKey2'], isForced: false })
```
Parameters
- this: any
- params: { attributeKeys: string[]; chatRoomId: string; isForced?: boolean }
  - attributeKeys: string[]
    
    The array of keys of attributes to remove. The array can contain a maximum number of 10 attribute keys.
  - chatRoomId: string
    
    The chat room ID.
  - Optional isForced?: boolean
    Whether to allow chat room members to overwrite the chat room attributes set by others.
    
    true: Yes;
    
    (Default)false: No.
Returns Promise<AsyncResult<ChatroomAttributes>>

removeChatRoomMember

removeChatRoomMember(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

Removes a chat room member.
```
connection.removeChatRoomMember({chatRoomId: 'chatRoomId', username: 'username'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The member to be removed.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

setChatRoomAdmin

setChatRoomAdmin(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<SetChatRoomAdminResult>>

Sets a member as the chat room admin.
note
Only the chat room owner can call this method. The new admin will receive "operation: 'setAdmin'" in the callback of onChatroomEvent.
```
connection.setChatRoomAdmin({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The members to be set as admin.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SetChatRoomAdminResult>): void
    - Parameters
      - res: AsyncResult<SetChatRoomAdminResult>
      Returns void
Returns Promise<AsyncResult<SetChatRoomAdminResult>>

setChatRoomAttribute

setChatRoomAttribute(this: any, params: { attributeKey: string; attributeValue: string; autoDelete?: boolean; chatRoomId: string; isForced?: boolean }): Promise<void>

Sets a custom chat room attribute.
```
connection.setChatroomAttribute({chatRoomId: 'chatRoomId', attributeKey: "attributeKey1", attributeValue: "attributeValue1", autoDelete: true, isForced: false})
```
Parameters
- this: any
- params: { attributeKey: string; attributeValue: string; autoDelete?: boolean; chatRoomId: string; isForced?: boolean }
  - attributeKey: string
    The chat room attribute key. A single key cannot exceed 128 characters; the total number of keys in a chat room cannot exceed 100. The following character sets are supported:
    
    26 lowercase English letters (a-z)
    
    26 uppercase English letters (A-Z)
    
    10 numbers (0-9)
    
    "_", "-", "."
  - attributeValue: string
    
    The chat room attribute value. The attribute value can contain a maximum of 4096 characters. The total length of custom chat room attributes cannot exceed 10 GB for each app.
  - Optional autoDelete?: boolean
    Whether to delete chat room attributes set by the member when he or she exits the chat room.
    
    (Default)true: Yes;
    
    false: No.
  - chatRoomId: string
    
    The chat room ID.
  - Optional isForced?: boolean
    Whether to delete chat room attributes set by the member when he or she exits the chat room.
    
    (Default)true: Yes;
    
    false: No.
Returns Promise<void>

setChatRoomAttributes

setChatRoomAttributes(this: any, params: { attributes: {}; autoDelete?: boolean; chatRoomId: string; isForced?: boolean }): Promise<AsyncResult<ChatroomAttributes>>

Sets the chat room attributes in batches.
```
connection.setChatRoomAttributes({chatRoomId: 'chatRoomId', attributes: {"attributeKey1": "attributeValue1"}, autoDelete: true, isForced: false})
```
Parameters
- this: any
- params: { attributes: {}; autoDelete?: boolean; chatRoomId: string; isForced?: boolean }
  - attributes: {}
    
    The map of custom chat room attributes.
    - [key: string]: string
  - Optional autoDelete?: boolean
    
    Whether to delete chat room attributes set by the member when he or she exits the chat room. - (Default)true: Yes. - false: No.
  - chatRoomId: string
    
    The chat room ID.
  - Optional isForced?: boolean
    
    Whether to allow a member to overwrite the chat room attribute set by another member. - true: Yes. -(Default)false: No.
Returns Promise<AsyncResult<ChatroomAttributes>>

unblockChatRoomMember

unblockChatRoomMember(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

Removes a member from the the block list of the chat room.
note
Only the chat room owner or admin can call this method.
```
connection.unblockChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The member to be removed from the block list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

unblockChatRoomMembers

unblockChatRoomMembers(this: any, params: { chatRoomId: string; usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<ChatRoomType.CommonRequestResult[]>>

Removes members from the block list of the chat room. Only the chat room owner or admin can call this method.
```
connection.unblockChatRoomMembers({chatRoomId: 'chatRoomId', usernames: ['user1', 'user2']})
```
Parameters
- this: any
- params: { chatRoomId: string; usernames: string[]; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - usernames: string[]
    
    The array of members to be removed from the block list.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ChatRoomType.CommonRequestResult[]>): void
    - Parameters
      - res: AsyncResult<ChatRoomType.CommonRequestResult[]>
      Returns void
Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult[]>>

unmuteChatRoomMember

unmuteChatRoomMember(this: any, params: { chatRoomId: string; username: string; error?: any; success?: any }): Promise<AsyncResult<UnmuteChatRoomMemberResult[]>>

Unmutes the chat room member.
note
Only the chat room owner can call this method. The members who are unmuted and other admins will receive "operation: 'unmuteMember'" in the callback of onChatroomEvent.
```
connection.unmuteChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- this: any
- params: { chatRoomId: string; username: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - username: string
    
    The member to be unmuted.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<UnmuteChatRoomMemberResult[]>): void
    - Parameters
      - res: AsyncResult<UnmuteChatRoomMemberResult[]>
      Returns void
Returns Promise<AsyncResult<UnmuteChatRoomMemberResult[]>>

updateChatRoomAnnouncement

updateChatRoomAnnouncement(this: any, params: { announcement: string; roomId: string; error?: any; success?: any }): Promise<AsyncResult<UpdateChatRoomAnnouncementResult>>

Updates the announcement of the chat room.
```
connection.updateChatRoomAnnouncement({roomId: 'roomId', announcement: 'hello'})
```
Parameters
- this: any
- params: { announcement: string; roomId: string; error?: any; success?: any }
  - announcement: string
    
    The announcement content.
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<UpdateChatRoomAnnouncementResult>): void
    - Parameters
      - res: AsyncResult<UpdateChatRoomAnnouncementResult>
      Returns void
Returns Promise<AsyncResult<UpdateChatRoomAnnouncementResult>>

uploadChatRoomSharedFile

uploadChatRoomSharedFile(this: any, params: { file: object; roomId: string; onFileUploadCanceled?: any; onFileUploadComplete?: any; onFileUploadError?: any; onFileUploadProgress?: any }): void

Uploads a shared file to the chat room.
```
connection.uploadChatRoomSharedFile({roomId: 'roomId', file: 'file object', onFileUploadProgress: onFileUploadProgress, onFileUploadComplete: onFileUploadComplete,onFileUploadError:onFileUploadError,onFileUploadCanceled:onFileUploadCanceled})
```
Parameters
- this: any
- params: { file: object; roomId: string; onFileUploadCanceled?: any; onFileUploadComplete?: any; onFileUploadError?: any; onFileUploadProgress?: any }
  - file: object
    
    The shared file object to upload.
  - roomId: string
    
    The chat room ID.
  - onFileUploadCanceled?:function
    - onFileUploadCanceled(): void
    - The upload cancellation callback.
      
      Returns void
  - onFileUploadComplete?:function
    - onFileUploadComplete(data: any): void
    - The upload completion callback.
      
      Parameters
      - data: any
      Returns void
  - onFileUploadError?:function
    - onFileUploadError(data: any): void
    - The upload failure callback.
      
      Parameters
      - data: any
      Returns void
  - onFileUploadProgress?:function
    - onFileUploadProgress(data: any): void
    - The upload progress callback.
      
      Parameters
      - data: any
      Returns void
Returns void

Index

Functions

Functions

addUsersToChatRoomAllowlist

Parameters

this: any

params: { chatRoomId: string; users: string[]; error?: any; success?: any }

chatRoomId: string

users: string[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>

Returns void

Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult | ChatRoomType.CommonRequestResult[]>>

blockChatRoomMember

Parameters

this: any

params: { chatRoomId: string; username: string; error?: any; success?: any }

chatRoomId: string

username: string

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<ChatRoomType.CommonRequestResult>

Returns void

Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult>>

blockChatRoomMembers

Parameters

this: any

params: { chatRoomId: string; usernames: string[]; error?: any; success?: any }

chatRoomId: string

usernames: string[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<ChatRoomType.CommonRequestResult[]>

Returns void

Returns Promise<AsyncResult<ChatRoomType.CommonRequestResult[]>>

createChatRoom

Parameters

this: any

params: { description: string; maxusers: number; members?: string[]; name: string; token?: string; error?: any; success?: any }

description: string

maxusers: number

Optional members?: string[]

name: string

Optional token?: string

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<CreateChatRoomResult>

Returns void

Returns Promise<AsyncResult<CreateChatRoomResult>>

deleteChatRoomSharedFile

Parameters

this: any

params: { fileId: string; roomId: string; error?: any; success?: any }

fileId: string

roomId: string

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<DeleteChatRoomSharedFileResult>

Returns void