Documentation
Chat (BETA)
Console 官网 Community Technical support
English
search-icon

Agora Chat Web API Reference

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

Group contains APIs for group-related operations.

Index

Functions

Functions

Const acceptGroupInvite

  • Accepts a group invitation. If a group member invites a user to join the group, the invitee can call this method to accept the invitation. The inviter will receive "operation: 'acceptInvite'" in the callback of onGroupEvent. The new group member will receive "operation: 'memberPresence'" in the callback of onGroupEvent.

    connection.acceptGroupInvite({invitee: 'myUserId', groupId: 'groupId'})

    Parameters

    Returns Promise<AsyncResult<CommonRequestResult>>

Const acceptGroupJoinRequest

  • Accepts a group request. Only the group owner or admin can call this method. The user who joins the group will receive "operation: 'acceptRequest'" in the callback of onGroupEvent.

    connection.acceptGroupJoinRequest({applicant: 'user1', groupId: 'groupId'})

    Parameters

    Returns Promise<AsyncResult<CommonRequestResult>>

Const addUsersToGroupAllowlist

  • Adds members to the group allowlist. Members on the allowlist can still post messages even if they are muted in the group. Only the group admin or above can call this method. Members added to the allowlist will receive "operation: 'addUserToAllowlist'" in the callback of onGroupEvent.

    connection.addUsersToGroupAllowlist({groupId: 'groupId'})

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const blockGroupMember

  • Adds a member to the group blocklist. Only the group owner or admin can call this method. The member added to the blocklist will receive "operation: 'removeMember'" in the callback of onGroupEvent.

    connection.blockGroupMember({groupId: 'groupId', username: 'user1'})

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult>>

Const blockGroupMembers

  • Adds members to the group blocklist in bulk. Only the group admin can call this method. Members added to the blocklist will receive "operation: 'removeMember'" in the callback of onGroupEvent.

    connection.blockGroupMembers({usernames: ['user1', 'user2'], groupId: 'groupId'})

    Parameters

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

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const blockGroupMessages

Const changeGroupOwner

  • Transfers a group. Only the group owner can call this method. Group members will receive "operation: 'changeOwner'" in the callback of onGroupEvent.

    connection.changeGroupOwner({groupId: 'groupId', newOwner: 'user1'})

    Parameters

    Returns Promise<AsyncResult<ChangeGroupOwnerResult>>

Const createGroup

  • createGroup(params: { data: { allowinvites: boolean; approval: boolean; desc: string; groupname: string; inviteNeedConfirm: boolean; maxusers: number; members: string[]; public: boolean }; error?: any; success?: any }): Promise<AsyncResult<CreateGroupResult>>

  • Creates a group instance.

    connection.createGroup({
     data: {
         groupname: 'groupname',
         desc: 'this is my group',
         members: ['user1', 'user2'],
         public: true,
          approval: false,
          allowinvites: true,
         inviteNeedConfirm: false
      }
    })

    Parameters

    • params: { data: { allowinvites: boolean; approval: boolean; desc: string; groupname: string; inviteNeedConfirm: boolean; maxusers: number; members: string[]; public: boolean }; error?: any; success?: any }
      • data: { allowinvites: boolean; approval: boolean; desc: string; groupname: string; inviteNeedConfirm: boolean; maxusers: number; members: string[]; public: boolean }

        The group information.

        • allowinvites: boolean

          Whether to allow group members to invite others to the group. true: Allow; false: Do not allow.

        • approval: boolean

          Whether a user requires the approval from the group admin to join the group. -true: Yes; -false: No.

        • desc: string

          The description of the group.

        • groupname: string

          The group name.

        • inviteNeedConfirm: boolean

          Whether the invitee needs to accept the invitation before joining the group.

          • true: The invitee's consent is required. The default value is true.
          • false: The invitee will be directly added to the group without confirmation.
        • maxusers: number

          The group max users.

        • members: string[]

          The array of member IDs to add to the group. These users will be added directly into the group and receive "operation: 'directJoined'" in the callback of onGroupEvent.

        • public: boolean

          Whether it is a public group. -true: Yes; -false: No. Public group: the group that others can query by calling listgroups.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<CreateGroupResult>>

deleteGroupSharedFile

Const destroyGroup

  • Destroys a group. Only the group owner can call this method. Group members will receive "operation: 'destroy'" in the callback of onGroupEvent.

    connection.destroyGroup({groupId: 'groupId'})

    Parameters

    Returns Promise<AsyncResult<DestroyGroupResult>>

disableSendGroupMsg

  • disableSendGroupMsg(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ mute: true }>>

  • Mutes all members. Only the group admin or above can call this method. Group members will receive "operation: 'muteAllMembers'" in the callback of onGroupEvent.

     connection.disableSendGroupMsg({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<{ mute: true }>>

downloadGroupSharedFile

  • downloadGroupSharedFile(params: { fileId: string; groupId: string; secret?: string; onFileDownloadComplete?: any; onFileDownloadError?: any }): void

  • Down load group file.

    connection.downloadGroupSharedFile({groupId: 'groupId', fileId: 'fileId', onFileDownloadComplete: (data)=>{console.log(data)}})

    Parameters

    • params: { fileId: string; groupId: string; secret?: string; onFileDownloadComplete?: any; onFileDownloadError?: any }
      • fileId: string
      • groupId: string
      • Optional secret?: string
      • onFileDownloadComplete?:function
        • onFileDownloadComplete(data: Blob): void

        • Parameters

          • data: Blob

          Returns void

      • onFileDownloadError?:function

    Returns void

enableSendGroupMsg

  • enableSendGroupMsg(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ mute: false }>>

  • Unmute all members. Only the group admin or above can call this method. Group members will receive "operation: 'unmuteAllMembers'" in the callback of onGroupEvent.

    connection.enableSendGroupMsg({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function

        • Parameters

          Returns void

    Returns Promise<AsyncResult<{ mute: false }>>

fetchGroupAnnouncement

  • fetchGroupAnnouncement(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ announcement: string }>>

  • Gets the group announcement.

    connection.fetchGroupAnnouncement({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function
        • success(res: AsyncResult<{ announcement: string }>): void

        • Parameters

          Returns void

    Returns Promise<AsyncResult<{ announcement: string }>>

getGroupAdmin

  • getGroupAdmin(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

  • Gets all admins in the group.

    connection.getGroupAdmin({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

Const getGroupAllowlist

  • getGroupAllowlist(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

  • Gets the group allowlist. Only the group admin or above can call this method.

    connection.getGroupAllowlist({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

Const getGroupBlocklist

  • getGroupBlocklist(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>

  • Gets the group blocklist.

    connection.getGroupBlocklist({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

getGroupInfo

getGroupMsgReadUser

Const getGroupMutelist

Const getGroupSharedFilelist

getJoinedGroups

  • getJoinedGroups(params: { needAffiliations?: boolean; needRole?: boolean; pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<BaseGroupInfo[]>>

  • Lists all the groups a user has joined.

    connection.getJoinedGroups({
            pageNum: 1,
            pageSize: 500
    })

    Parameters

    • params: { needAffiliations?: boolean; needRole?: boolean; pageNum: number; pageSize: number; error?: any; success?: any }
      • Optional needAffiliations?: boolean

        Whether the number of group members is required.

      • Optional needRole?: boolean

        Whether the role of the account in the group is required.

      • pageNum: number

        The current page number.

      • pageSize: number

        The number of group per page.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

Const getPublicGroups

  • getPublicGroups(params: { cursor?: string; limit: number; error?: any; success?: any }): Promise<AsyncResult<BaseGroupInfo[]>>

  • Gets public groups with pagination.

    connection.getPublicGroups({limit: 20, cursor: null})

    Parameters

    • params: { cursor?: string; limit: number; error?: any; success?: any }
      • 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.

      • limit: number

        The number of records per page.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

Const inviteUsersToGroup

  • Invites users into a group. Creates a group instance "inviteNeedConfirm:true", the invited users will receive "operation: 'inviteToJoin'" in the callback of onGroupEvent. Creates a group instance "inviteNeedConfirm:false", the invited users will receive "operation: 'directJoined'" in the callback of onGroupEvent.

    connection.inviteUsersToGroup({groupId: 'groupId', users: ['user1', 'user2']})

    Parameters

    Returns Promise<AsyncResult<InviteUsersToGroupResult[]>>

Const isInGroupAllowlist

  • Checks whether the current member is on the allowlist. The app admin can check all users; app users can only check themselves.

    connection.isInGroupAllowlist({groupId: 'groupId', userName: 'user1'})

    Parameters

    Returns Promise<AsyncResult<IsInGroupWhiteListResult>>

joinGroup

  • Applies to join the group. The group owner and admin will receive "operation: 'requestToJoin'" in the callback of onGroupEvent.

    connection.joinGroup({groupId: 'groupId', message: 'I want to join the group'})

    Parameters

    Returns Promise<AsyncResult<CommonRequestResult>>

Const leaveGroup

  • leaveGroup(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ result: true }>>

  • Leaves the group. Group members will receive "operation: 'memberAbsence'" in the callback of onGroupEvent.

    connection.leaveGroup({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • error?:function
      • success?:function

        • Parameters

          Returns void

    Returns Promise<AsyncResult<{ result: true }>>

Const listGroupMembers

  • listGroupMembers(params: { groupId: string; pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<GroupMember[]>>

  • Lists all members of the group with pagination.

    connection.listGroupMembers({pageNum: 1, pageSize: 20, groupId: 'groupId'})

    Parameters

    • params: { groupId: string; pageNum: number; pageSize: number; error?: any; success?: any }
      • groupId: string

        The group ID。

      • pageNum: number

        The page number, starting from 1.

      • pageSize: number

        The number of members per page. The value cannot exceed 1000.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<GroupMember[]>>

modifyGroup

  • modifyGroup(params: { description: string; groupId: string; groupName: string; error?: any; success?: any }): Promise<AsyncResult<ModifyGroupResult>>

  • Modifies group information. Only the group admin can call this method.

    connection.modifyGroup({groupId: 'groupId', groupName: 'groupName', description:'description'})

    Parameters

    • params: { description: string; groupId: string; groupName: string; error?: any; success?: any }

    Returns Promise<AsyncResult<ModifyGroupResult>>

Const muteGroupMember

  • Mutes a group member. Only the group owner or admin can call this method. The muted member and other members will receive "operation:'muteMember'" in the callback of onGroupEvent.

    connection.muteGroupMember({username: 'user1', muteDuration: -1, groupId: 'groupId'})

    Parameters

    • params: { groupId: string; muteDuration: number; username: string; error?: any; success?: any }
      • groupId: string

        The group ID.

      • muteDuration: number

        The mute duration in milliseconds. The value -1 indicates that the member is muted permanently.

      • username: string

        The ID of the group member to mute.

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<MuteGroupMemberResult[]>>

Const rejectGroupInvite

  • rejectGroupInvite(params: { groupId: string; invitee: string; error?: any; success?: any }): Promise<any>

  • Declines a group invitation. If a group member invites a user to join a group, the invitee can call this method to decline this invitation.

    connection.rejectGroupInvite({invitee: 'myUserId', groupId: 'groupId'})

    Parameters

    Returns Promise<any>

Const rejectGroupJoinRequest

  • rejectGroupJoinRequest(params: { applicant: string; groupId: string; reason: string; error?: any; success?: any }): Promise<AsyncResult<CommonRequestResult>>

  • Declines a group request. Only the group owner or admin can call this method.

    connection.rejectGroupJoinRequest({applicant: 'user1', groupId: 'groupId', reason: 'I do not like you'})

    Parameters

    • params: { applicant: string; groupId: string; reason: string; error?: any; success?: any }

    Returns Promise<AsyncResult<CommonRequestResult>>

Const removeGroupAdmin

Const removeGroupAllowlistMember

  • Removes a member from the group allowlist. Only the group admin or above can call this method. The user that is removed from the group allowlist will receive "operation:'removeAllowlistMember'" in the callback of onGroupEvent.

    connection.removeGroupAllowlistMember({groupId: 'groupId', userName: 'user1'})

    Parameters

    • params: { groupId: string; userName: string; error?: any; success?: any }

    Returns Promise<AsyncResult<GroupRequestResult>>

Const removeGroupMember

  • Removes a member from the group. Only the group owner or admin can call this method. The removed member will receive "operation: 'removeMember'" in the callback of onGroupEvent, and other group members will receive "operation: 'memberAbsence' in the callback of onGroupEvent.

    connection.removeGroupMember({groupId: 'groupId', username: 'user1'})

    Parameters

    Returns Promise<AsyncResult<RemoveGroupMemberResult>>

Const removeGroupMembers

  • Removes members from the group. Only the group owner or admin can call this method. The removed members will receive "operation: 'removeMember'" in the callback of onGroupEvent, and other group members will receive "operation: 'memberAbsence'" in the callback of onGroupEvent.

    connection.removeGroupMembers({groupId: 'groupId', users: ['user1', 'user2']})

    Parameters

    Returns Promise<AsyncResult<RemoveGroupMemberResult[]>>

Const setGroupAdmin

  • Sets a group admin. Only the group owner can call this method. The user set as an admin will receive "operation: 'setAdmin'" in the callback of onGroupEvent.

    connection.setGroupAdmin({groupId: 'groupId', username: 'user1'})

    Parameters

    Returns Promise<AsyncResult<SetGroupAdminResult>>

Const unblockGroupMember

  • Removes a member from the group blocklist. Only the group admin can call this method. Members who are removed from the blocklist will receive "operation: 'unblockMember'" in the callback of onGroupEvent.

    connection.unblockGroupMember({groupId: 'groupId'})

    Parameters

    • params: { groupId: string; username: string; error?: any; success?: any }

    Returns Promise<AsyncResult<GroupRequestResult>>

Const unblockGroupMembers

  • Removes members from the group blocklist in bulk. Only the group owner or admin can call this method. Members who are removed from the blocklist will receive "operation: 'unblockMember'" in the callback of onGroupEvent.

    connection.unblockGroupMembers({groupId: 'groupId', usernames: ['user1', 'user2']})

    Parameters

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

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const unmuteGroupMember

  • Unmute a group member. Only the group owner or admin can call this method. The unmuted member and other members will receive "operation: 'unmuteMember'" in the callback of onGroupEvent.

    connection.unmuteGroupMember({groupId: 'groupId', username: 'user1'})

    Parameters

    Returns Promise<AsyncResult<UnmuteGroupMemberResult[]>>

updateGroupAnnouncement

uploadGroupSharedFile

  • uploadGroupSharedFile(params: { file: object; groupId: string; onFileUploadCanceled?: any; onFileUploadComplete?: any; onFileUploadError?: any; onFileUploadProgress?: any }): void

  • Uploads shared files to the group.

    connection.uploadGroupSharedFile({groupId: 'groupId', file: 'file object', onFileUploadProgress: onFileUploadProgress, onFileUploadComplete: onFileUploadComplete,onFileUploadError:onFileUploadError,onFileUploadCanceled:onFileUploadCanceled})

    Parameters

    • params: { file: object; groupId: string; onFileUploadCanceled?: any; onFileUploadComplete?: any; onFileUploadError?: any; onFileUploadProgress?: any }
      • file: object

        The shared file object to upload.

      • groupId: string

        The group 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: ProgressEvent<EventTarget>): void

        • The upload progress callback.

          Parameters

          • data: ProgressEvent<EventTarget>

          Returns void

    Returns void