Options
All
  • Public
  • Public/Protected
  • All
Menu

Group contains APIs for group-related operations.

Index

Functions

Const acceptGroupInvite

  • 接受入群邀请。群组成员邀请用户入群时,用户可调用该方法接受邀请。邀请者会在 onGroupEvent 的回调里收到 operation: 'acceptInvite',加入成功之后群成员会在 onGroupEvent 的回调里收到 operation: 'memberPresence'。

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

    Parameters

    Returns Promise<AsyncResult<CommonRequestResult>>

Const acceptGroupJoinRequest

  • 同意用户加入群。仅群主和管理员可调用此方法。加入群组的用户会在 onGroupEvent 的回调里收到 operation: 'acceptRequest'。

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

    Parameters

    Returns Promise<AsyncResult<CommonRequestResult>>

Const addUsersToGroupAllowlist

  • 添加白名单。白名单里的成员可以在群禁言之后继续发言。仅群组管理员及以上身份可调用此方法。添加到白名单的成员会在 onGroupEvent 的回调里收到 operation: 'addUserToAllowlist'。

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

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const blockGroupMember

  • 将单个成员加入群组黑名单。仅群主和管理员可调用此方法。添加到黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'removeMember'。

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

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult>>

Const blockGroupMembers

  • 批量添加成员至群组黑名单。仅群组管理员可调用此方法。添加到黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'removeMember'。

    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

  • 转让群组。仅群主可调用此方法。群成员会在 onGroupEvent 回调里收到 operation:'changeOwner'。

    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>>
  • 创建群组。

    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 }

        群组信息。

        • allowinvites: boolean

          是否允许群成员邀请其他人进群。true:允许;false:不允许。

        • approval: boolean

          加群是否需要管理员审批。- true:需要;- false:不需要。

        • desc: string

          群组描述。

        • groupname: string

          群组名称。

        • inviteNeedConfirm: boolean

          受邀人加入群组前是否需接受入群邀请。

          • true :需受邀人确认入群邀请。默认值为 true
          • false:受邀人直接加入群组,无需确认入群邀请。
        • maxusers: number

          群组最大成员数。

        • members: string[]

          群成员 ID 数组,这些用户会被直接加入群组,在 onGroupEvent 回调里收到 operation:'directJoined'。

        • public: boolean

          是否为公开群,公开群:其他人可以调用 listGroups 查询到的群组。- true:公开群;- false:非公开群。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<CreateGroupResult>>

deleteGroupSharedFile

Const destroyGroup

disableSendGroupMsg

  • disableSendGroupMsg(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ mute: true }>>
  • 设置全员禁言。仅群组管理员及以上身份可调用此方法。群组成员会在 onGroupEvent 的回调里收到 operation: 'muteAllMembers'

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

    Parameters

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

        群组 ID。

      • error?:function
      • success?:function

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

downloadGroupSharedFile

  • downloadGroupSharedFile(params: { fileId: string; groupId: string; secret?: string; onFileDownloadComplete?: any; onFileDownloadError?: any }): void
  • 下载群文件。

    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 }>>
  • 解除全员禁言。仅群组管理员及以上身份可调用此方法。群组成员会在 onGroupEvent 的回调中收到 operation: 'unmuteAllMembers'。

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

    Parameters

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

        群组 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 }>>
  • 获取群公告。

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

    Parameters

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

        群组 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[]>>
  • 获取群组下所有管理员。

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

    Parameters

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

        群组 ID。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

Const getGroupAllowlist

  • getGroupAllowlist(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>
  • 获取群组白名单列表。仅群组管理员及以上身份可调用此方法。

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

    Parameters

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

        群组 ID。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

Const getGroupBlocklist

  • getGroupBlocklist(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<UserId[]>>
  • 获取群组黑名单。

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

    Parameters

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

        群组 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[]>>
  • 列出某用户加入的所有群组。

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

    Parameters

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

        是否需要群组成员数。

      • Optional needRole?: boolean

        是否需要该帐户在组中的角色。

      • pageNum: number

        当前页码。

      • pageSize: number

        每页获取的群组数量。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

Const getPublicGroups

  • getPublicGroups(params: { cursor?: string; limit: number; error?: any; success?: any }): Promise<AsyncResult<BaseGroupInfo[]>>
  • 分页获取公开群。

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

    Parameters

    • params: { cursor?: string; limit: number; error?: any; success?: any }
      • Optional cursor?: string

        游标。如果数据还有下一页,该方法的返回值会包含此字段,传递此字段可获取下一页的数据,为 null 时获取第一页数据

      • limit: number

        每页返回的公开群组数。

      • error?:function
      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

Const inviteUsersToGroup

  • 邀请用户加群。 群组创建时 inviteNeedConfirm:true,被邀请的用户会在 onGroupEvent 的回调中收到 operation: 'inviteToJoin'。 群组创建时 inviteNeedConfirm:false,被邀请的用户会在 onGroupEvent 的回调中收到 operation: 'directJoined'。

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

    Parameters

    Returns Promise<AsyncResult<InviteUsersToGroupResult[]>>

Const isInGroupAllowlist

joinGroup

  • 申请加入群组。群主和管理员会在 onGroupEvent 的回调中收到 operation:'requestToJoin'。

    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 }>>
  • 离开群组。群组成员会在 onGroupEvent 的回调中收到 operation: 'memberAbsence'。

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

    Parameters

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

        群组 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[]>>
  • 分页列出群组的所有成员。

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

    Parameters

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

        群组 ID。

      • pageNum: number

        当前页码,从 1 开始。

      • pageSize: number

        每页返回的成员数,最大值是 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>>
  • 修改群信息。仅群组管理员可调用此方法。

    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

  • 将一个群组成员禁言。仅群主和管理员可调用此方法。禁言的成员和其他成员会在 onGroupEvent 的回调中收到 operation:'muteMember'。

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

    Parameters

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

    Returns Promise<AsyncResult<MuteGroupMemberResult[]>>

Const rejectGroupInvite

  • rejectGroupInvite(params: { groupId: string; invitee: string; error?: any; success?: any }): Promise<any>
  • 拒绝入群邀请。群组成员邀请用户入群时,用户可调用该方法拒绝邀请。

    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>>
  • 拒绝入群申请。仅群主和管理员可调用此方法。

    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

  • 移除白名单。仅群组管理员及以上身份可调用此方法。移除白名单的用户会在 onGroupEvent 的回调中收到 operation:'removeAllowlistMember'。

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

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult>>

Const removeGroupMember

  • 将群成员移出群组。仅群主和管理员可调用此方法。被移出的成员会在 onGroupEvent 的回调中收到 operation:'removeMember',其他群成员会在 onGroupEvent 的回调中收到 operation:'memberAbsence'。

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

    Parameters

    Returns Promise<AsyncResult<RemoveGroupMemberResult>>

Const removeGroupMembers

  • 将多个群成员移出群组。仅群主和管理员可调用此方法。被移出的成员会在 onGroupEvent 的回调中收到 operation:'removeMember',其他群成员会在 onGroupEvent 的回调中收到 operation:'memberAbsence'。

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

    Parameters

    Returns Promise<AsyncResult<RemoveGroupMemberResult[]>>

Const setGroupAdmin

  • 设置群管理员。仅群主可调用此方法。设置为管理员的用户会在 onGroupEvent 的回调里收到 operation: 'setAdmin'。

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

    Parameters

    Returns Promise<AsyncResult<SetGroupAdminResult>>

Const unblockGroupMember

  • 将单个成员从群组黑名单移除。仅群组管理员可调用此方法。移除黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'unblockMember'。

    connection.unblockGroupMember({groupId: 'groupId', username: 'user'})
    

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult>>

Const unblockGroupMembers

  • 将成员批量移除群组黑名单。仅群主和管理员可调用此方法。移除黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'unblockMember'。

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

    Parameters

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const unmuteGroupMember

  • 解除禁言。仅群主和管理员可调用此方法。解除禁言的用户和其他用户会在 onGroupEvent 的回调里收到 operation: 'unmuteMember'。

    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
  • 上传群组共享文件。

    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

        上传的文件对象。

      • groupId: string

        群组 ID。

      • onFileUploadCanceled?:function
        • onFileUploadCanceled(data: any): void
        • 上传取消的回调。

          Parameters

          • data: any

          Returns void

      • onFileUploadComplete?:function
        • onFileUploadComplete(data: any): void
        • 上传完成的回调。

          Parameters

          • data: any

          Returns void

      • onFileUploadError?:function
        • onFileUploadError(data: any): void
        • 上传失败的回调。

          Parameters

          • data: any

          Returns void

      • onFileUploadProgress?:function
        • onFileUploadProgress(data: ProgressEvent<EventTarget>): void
        • 上传进度的回调。

          Parameters

          • data: ProgressEvent<EventTarget>

          Returns void

    Returns void

Generated using TypeDoc