Documentation





Chat (BETA)

Console 官网 Community Technical support





Agora Chat Web API Reference

Overview ChatSDK Chatroom Connection Contact EventHandler Group Logger Message Presence SilentMode StatusCode Thread Translation Types

Chatroom contains APIs for chatroom-related operations.

Functions

Const addUsersToChatRoomAllowlist

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

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

Const blockChatRoomMember

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

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

Const blockChatRoomMembers

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

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

createChatRoom

createChatRoom(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
- 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 of integer type, 200 by default, and can not exceed 5,000.
  - members: string[]
    
    (Optional) The members in the chat room. An array of user IDs. If you set this parameter, ensure that the array contains at least one user.
  - name: string
    
    The chat room name.
  - token: string
    
    The super admin token.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CreateChatRoomResult>): void
    - Parameters
      - res: AsyncResult<CreateChatRoomResult>
      Returns void
Returns Promise<AsyncResult<CreateChatRoomResult>>

deleteChatRoomSharedFile

deleteChatRoomSharedFile(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
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<DeleteChatRoomSharedFileResult>): void
    - Parameters
      - res: AsyncResult<DeleteChatRoomSharedFileResult>
      Returns void
Returns Promise<AsyncResult<DeleteChatRoomSharedFileResult>>

destroyChatRoom

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

Destroys the chat room.
```
connection.destroyChatRoom({chatRoomId: 'chatRoomId', token: 'your token'})
```
Parameters
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CreateChatRoomResult>): void
    - Parameters
      - res: AsyncResult<CreateChatRoomResult>
      Returns void
Returns Promise<AsyncResult<CreateChatRoomResult>>

disableSendChatRoomMsg

disableSendChatRoomMsg(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.
```
connection.disableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
```
Parameters
- params: { chatRoomId: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<WhetherAbleSendChatRoomMsgResult>): void
    - Parameters
      - res: AsyncResult<WhetherAbleSendChatRoomMsgResult>
      Returns void
Returns Promise<AsyncResult<WhetherAbleSendChatRoomMsgResult>>

enableSendChatRoomMsg

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

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

fetchChatRoomAnnouncement

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

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

getChatRoomAdmin

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

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

Const getChatRoomAllowlist

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

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

Const getChatRoomBlocklist

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

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

getChatRoomDetails

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

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

Const getChatRoomMutelist

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

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

Const getChatRoomSharedFilelist

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

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

getChatRooms

getChatRooms(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
- params: { pagenum: number; pagesize: number; error?: any; success?: any }
  - pagenum: number
    
    The page number, starting from 1.
  - pagesize: number
    
    The number of records per page. The default value is 20.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetChatRoomsResult>): void
    - Parameters
      - res: AsyncResult<GetChatRoomsResult>
      Returns void
Returns Promise<AsyncResult<GetChatRoomsResult>>

Const isInChatRoomAllowlist

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

Checks whether chat room members are on the allowlist. 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
- params: { chatRoomId: string; userName: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - userName: string
    
    The member ID.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<IsChatRoomWhiteUserResult>): void
    - Parameters
      - res: AsyncResult<IsChatRoomWhiteUserResult>
      Returns void
Returns Promise<AsyncResult<IsChatRoomWhiteUserResult>>

joinChatRoom

joinChatRoom(params: { message?: string; roomId: string; error?: any; success?: any }): Promise<AsyncResult<CommonRequestResult>>

Joins the chat room. After a user joins successfully, other members in the chat room will receive operation: 'memberPresence' in the onChatroomEvent callback.
```
connection.joinChatRoom({roomId: 'roomId'})
```
Parameters
- params: { message?: string; roomId: string; error?: any; success?: any }
  - Optional message?: string
    
    The reason for joining the chat room. It is optional. It is only used for groups.
  - roomId: string
    
    The chat room ID.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<CommonRequestResult>>

Const leaveChatRoom

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

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

Const listChatRoomMembers

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

Lists all chat room members with pagination.
```
connection.listChatRoomMembers({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
```
Parameters
- 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 per page. The value cannot exceed 1,000.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<{ member: string }[]>): void
    - Parameters
      - res: AsyncResult<{ member: string }[]>
      Returns void
Returns Promise<AsyncResult<{ member: string }[]>>

modifyChatRoom

modifyChatRoom(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
- params: { chatRoomId: string; chatRoomName: string; description: string; maxusers: number; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - chatRoomName: string
    
    The chat room name.
  - description: string
    
    The description of the chat room.
  - maxusers: number
    
    The maximum number of members in the chat room.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<ModifyChatRoomResult>): void
    - Parameters
      - res: AsyncResult<ModifyChatRoomResult>
      Returns void
Returns Promise<AsyncResult<ModifyChatRoomResult>>

muteChatRoomMember

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

Mutes chat room member. Only the chat room owner can call this method. The muted member and other members will receive "operation:'muteMember'" in the callback of onChatroomEvent.
```
connection.muteChatRoomMember({username: 'user1', muteDuration: -1, chatRoomId: 'chatRoomId'})
```
Parameters
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<MuteChatRoomMemberResult>): void
    - Parameters
      - res: AsyncResult<MuteChatRoomMemberResult>
      Returns void
Returns Promise<AsyncResult<MuteChatRoomMemberResult>>

removeChatRoomAdmin

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

Removes chat room admins. 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
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<RemoveChatRoomAdminResult>): void
    - Parameters
      - res: AsyncResult<RemoveChatRoomAdminResult>
      Returns void
Returns Promise<AsyncResult<RemoveChatRoomAdminResult>>

Const removeChatRoomAllowlistMember

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

Removes members from the allowlist 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
- params: { chatRoomId: string; userName: string; error?: any; success?: any }
  - chatRoomId: string
    
    The chat room ID.
  - userName: string
    
    The members to be removed from the allowlist.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<CommonRequestResult>>

Const removeChatRoomMember

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

Removes a chat room member.
```
connection.removeChatRoomMember({chatRoomId: 'chatRoomId', username: 'username'})
```
Parameters
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CommonRequestResult>): void
    - Parameters
      - res: AsyncResult<CommonRequestResult>
      Returns void
Returns Promise<AsyncResult<CommonRequestResult>>

setChatRoomAdmin

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

Sets a user as chat room admin. Only the chat room owner can call this method. The members who are set as admins will receive "operation: 'setAdmin'" in the callback of onChatroomEvent.
```
connection.setChatRoomAdmin({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SetChatRoomAdminResult>): void
    - Parameters
      - res: AsyncResult<SetChatRoomAdminResult>
      Returns void
Returns Promise<AsyncResult<SetChatRoomAdminResult>>

Const unblockChatRoomMember

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

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

Const unblockChatRoomMembers

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

Removes members from the chat room blocklist. Only the chat room owner or admin can call this method.
```
connection.unblockChatRoomMembers({chatRoomId: 'chatRoomId', usernames: ['user1', 'user2']})
```
Parameters
- 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 blocklist.
  - error?:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<CommonRequestResult[]>): void
    - Parameters
      - res: AsyncResult<CommonRequestResult[]>
      Returns void
Returns Promise<AsyncResult<CommonRequestResult[]>>

Const unmuteChatRoomMember

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

Unmute the chat room member. Only the chat room owner can call this method. The members who are muted and others will receive "operation: 'unmuteMember'" in the callback of onChatroomEvent.
```
connection.unmuteChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
```
Parameters
- 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: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<UnmuteChatRoomMemberResult[]>): void
    - Parameters
      - res: AsyncResult<UnmuteChatRoomMemberResult[]>
      Returns void
Returns Promise<AsyncResult<UnmuteChatRoomMemberResult[]>>

updateChatRoomAnnouncement

updateChatRoomAnnouncement(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
- params: { announcement: string; roomId: string; error: any; success: any }
  - announcement: string
    
    The announcement content.
  - roomId: string
    
    The chat room ID.
  - error:function
    - error(error: ErrorEvent): void
    - Parameters
      - error: ErrorEvent
      Returns void
  - success:function
    - success(res: AsyncResult<UpdateChatRoomAnnouncementResult>): void
    - Parameters
      - res: AsyncResult<UpdateChatRoomAnnouncementResult>
      Returns void
Returns Promise<AsyncResult<UpdateChatRoomAnnouncementResult>>

uploadChatRoomSharedFile

uploadChatRoomSharedFile(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
- 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(data: any): void
    - The upload cancellation callback.
      
      Parameters
      - data: any
      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

Agora Chat Web API Reference

Index

Functions

Functions

Const addUsersToChatRoomAllowlist

Parameters

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

chatRoomId: string

users: string[]

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<CommonRequestResult | CommonRequestResult[]>

Returns void

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

Const blockChatRoomMember

Parameters

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

chatRoomId: string

username: string

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<CommonRequestResult>

Returns void

Returns Promise<AsyncResult<CommonRequestResult>>

Const blockChatRoomMembers

Parameters

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

chatRoomId: string

usernames: string[]

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<CommonRequestResult[]>

Returns void

Returns Promise<AsyncResult<CommonRequestResult[]>>

createChatRoom

Parameters

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

description: string

maxusers: number

members: string[]

name: string

token: string

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<CreateChatRoomResult>

Returns void

Returns Promise<AsyncResult<CreateChatRoomResult>>

deleteChatRoomSharedFile

Parameters

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

fileId: string

roomId: string

error?:function

Parameters

error: ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<DeleteChatRoomSharedFileResult>

Returns void

Returns Promise<AsyncResult<DeleteChatRoomSharedFileResult>>

destroyChatRoom

Parameters

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