Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the doc comment for file1.ts

Specify this is a module comment and rename it to my-module:

Index

Functions

Const acceptGroupInvite

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

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

    Parameters

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

    Returns Promise<AsyncResult<CommonRequestResult>>

Const acceptGroupJoinRequest

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

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

    Parameters

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

    Returns Promise<AsyncResult<CommonRequestResult>>

addUsersToGroupWhitelist

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

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

    Parameters

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

        群组 ID。

      • users: string[]

        将要加入白名单的成员 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult[]>>

agreeInviteIntoGroup

  • 接受入群邀请。群组成员邀请用户入群可调用该方法接受入群邀请。邀请者会在 onGroupChange 的回调中收到 type: 'invite_accept',加入成功之后群成员会在 onGroupChange 的回调里收到 type: 'memberJoinPublicGroupSuccess'。

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

    已废弃,请用 acceptGroupInvite 代替。

    Parameters

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

    Returns Promise<AsyncResult<CommonRequestResult>>

agreeJoinGroup

  • 同意用户加入群。仅群主和管理员可调用此方法。加入群组的用户会在 onGroupChange 的回调中收到 type: 'joinPublicGroupSuccess'。

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

    已废弃,请用 acceptGroupJoinRequest 代替。

    Parameters

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

    Returns Promise<AsyncResult<CommonRequestResult>>

blockGroup

  • 屏蔽群组消息,只对移动端有效。

    connection.blockGroup({groupId: 'groupId'})
    
    deprecated

    已废弃,请用 blockGroupMessages 代替。

    Parameters

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

    Returns Promise<AsyncResult<BlockGroupResult>>

Const blockGroupMember

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

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

    Parameters

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

    Returns Promise<AsyncResult<GroupRequestResult>>

Const blockGroupMembers

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

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

    Parameters

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

        群组 ID。

      • usernames: string[]

        要加入群组黑名单的成员用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const blockGroupMessages

  • 屏蔽群组消息。该方法只对移动终端有效。

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

    Parameters

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

    Returns Promise<AsyncResult<BlockGroupResult>>

Const changeGroupOwner

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

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

    Parameters

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

    Returns Promise<AsyncResult<ChangeGroupOwnerResult>>

changeOwner

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

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

    已废弃,请用 changeGroupOwner 代替。

    Parameters

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

    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 数组,这些用户会被直接加入群组,在 onGroupChange 回调里收到 type:'direct_joined'。

        • public: boolean

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

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<CreateGroupResult>>

createGroupNew

  • createGroupNew(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.createGroupNew({
    data: {
    groupname: 'groupname',
    desc: 'this is my group',
    members: ['user1', 'user2'],
    public: true,
    approval: false,
    allowinvites: true,
    inviteNeedConfirm: false
    }
    })
    deprecated

    已废弃,请用 createGroup 代替。

    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 数组,这些用户会被直接加入群组,在 onGroupChange 回调里收到 type:'direct_joined'。

        • public: boolean

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

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<CreateGroupResult>>

deleteGroupSharedFile

Const destroyGroup

  • 解散群组。仅群主可调用此方法。群组成员会在 onGroupChange 的回调中收到 type:'deleteGroupChat'。

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

    Parameters

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

    Returns Promise<AsyncResult<DestroyGroupResult>>

disableSendGroupMsg

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

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

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

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

dissolveGroup

  • 解散群组。仅群主可调用此方法。群组成员会在 onGroupChange 的回调中收到 type:'deleteGroupChat'。

    connection.dissolveGroup({groupId: 'groupId'})
    
    deprecated

    已废弃,请用 destroyGroup 代替。

    Parameters

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

    Returns Promise<AsyncResult<DestroyGroupResult>>

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
        • onFileDownloadError(err: ErrorEvent): void
        • Parameters

          • err: ErrorEvent

          Returns void

    Returns void

enableSendGroupMsg

  • enableSendGroupMsg(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ mute: false }>>
  • 解除全员禁言。仅群组管理员及以上身份可调用此方法。群组成员会在 onGroupChange 的回调中收到 type: 'rmGroupMute'。

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

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • 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
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

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

          Returns void

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

fetchGroupSharedFileList

  • 获取群共享文件列表。

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

    Parameters

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

    Returns Promise<AsyncResult<FetchGroupSharedFileListResult>>

getGroup

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
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

Const getGroupBlacklist

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

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

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

getGroupBlacklistNew

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

    connection.getGroupBlacklistNew({groupId: 'groupId'})
    
    deprecated

    已废弃,请用 getGroupBlacklist 代替。

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

getGroupInfo

  • 获取群组详情。

    connection.getGroupInfo({groupId: groupId})
    

    Parameters

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

    Returns Promise<AsyncResult<GroupDetailInfo[]>>

getGroupMsgReadUser

  • 查询哪些成员读取了群组消息。[增值功能]仅旗舰版及以上支持,具体见 pricing。

    connection.getGroupMsgReadUser({groupId: 'groupId', msgId: 'msgId'})
    

    Parameters

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

    Returns Promise<AsyncResult<GetGroupMsgReadUserResult>>

Const getGroupMuteList

  • 获取群组的禁言列表。 仅群组管理员及以上身份可调用此方法。

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

    Parameters

    Returns Promise<AsyncResult<GetGroupMuteListResult[]>>

getGroupWhitelist

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

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

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<UserId[]>>

getJoinedGroups

  • getJoinedGroups(params: { pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<BaseGroupInfo[]>>
  • 列出某用户加入的所有群组。

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

    Parameters

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

        当前页码。

      • pageSize: number

        每页获取的群组数量。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

getMuted

groupBlockMulti

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

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

    已废弃,请用 blockGroupMembers 代替。

    Parameters

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

        群组 ID。

      • usernames: string[]

        要加入群组黑名单的成员用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult[]>>

groupBlockSingle

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

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

    已废弃,请用 blockGroupMember 代替。

    Parameters

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

    Returns Promise<AsyncResult<GroupRequestResult>>

inviteToGroup

  • 邀请用户加群。 群组创建时 inviteNeedConfirm:true,被邀请的用户会在 onGroupChange 的回调中收到 type: 'invite'。 群组创建时 inviteNeedConfirm:false,被邀请的用户会在 onGroupChange 的回调中收到 type: 'direct_joined'。

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

    已废弃,请用 inviteUsersToGroup 代替。

    Parameters

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

    Returns Promise<AsyncResult<InviteUsersToGroupResult[]>>

Const inviteUsersToGroup

  • 邀请用户加群。 群组创建时 inviteNeedConfirm:true,被邀请的用户会在 onGroupChange 的回调中收到 type: 'invite'。 群组创建时 inviteNeedConfirm:false,被邀请的用户会在 onGroupChange 的回调中收到 type: 'direct_joined'。

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

    Parameters

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

    Returns Promise<AsyncResult<InviteUsersToGroupResult[]>>

isGroupWhiteUser

  • 检查当前用户是否在群组白名单中。app admin 可查询所有用户;app user 可查询自己。

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

    已废弃,请用 isInGroupWhiteList 代替。

    Parameters

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

    Returns Promise<AsyncResult<IsInGroupWhiteListResult>>

Const isInGroupWhiteList

  • 检查当前用户是否在群组白名单中。app admin 可查询所有用户;app user 可查询自己。

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

    Parameters

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

    Returns Promise<AsyncResult<IsInGroupWhiteListResult>>

joinGroup

  • 申请加入群组。群主和管理员会在 onGroupChange 的回调中收到 type:'joinGroupNotifications'。

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

    Parameters

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

    Returns Promise<AsyncResult<CommonRequestResult>>

listGroupMember

  • listGroupMember(params: { groupId: string; pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<GroupMember[]>>
  • 分页列出群组的所有成员。

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

    请用 listGroupMembers 代替。

    Parameters

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

        群组 ID。

      • pageNum: number

        当前页码,从 1 开始。

      • pageSize: number

        每页返回的成员数,最大值是 1000。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupMember[]>>

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
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupMember[]>>

listGroups

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

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

    Parameters

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

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

      • limit: number

        每页返回的公开群组数。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<BaseGroupInfo[]>>

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 }
      • description: string

        群组描述。

      • groupId: string

        群组 ID。

      • groupName: string

        群组名称。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<ModifyGroupResult>>

mute

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

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

    已废弃,请用 muteGroupMember 代替。

    Parameters

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

        群组 ID。

      • muteDuration: number

        禁言时长,单位毫秒。如果是 -1 代表永久。

      • username: string

        禁言的群成员 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<MuteGroupMemberResult[]>>

Const muteGroupMember

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

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

    Parameters

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

        群组 ID。

      • muteDuration: number

        禁言时长,单位毫秒。如果是 -1 代表永久。

      • username: string

        禁言的群成员 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<MuteGroupMemberResult[]>>

quitGroup

  • quitGroup(params: { groupId: string; error?: any; success?: any }): Promise<AsyncResult<{ result: true }>>
  • 离开群组。群组成员会在 onGroupChange 的回调中收到 type: 'leaveGroup'。

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

    Parameters

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

        群组 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function
        • Parameters

          Returns void

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

Const rejectGroupInvite

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

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

    Parameters

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

    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 }
      • applicant: string

        申请加群的用户 ID。

      • groupId: string

        群组 ID。

      • reason: string

        拒绝原因。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<CommonRequestResult>>

rejectInviteIntoGroup

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

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

    已废弃,请用 rejectGroupInvite 代替。

    Parameters

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

    Returns Promise<any>

rejectJoinGroup

  • rejectJoinGroup(params: { applicant: string; groupId: string; reason: string; error?: any; success?: any }): Promise<AsyncResult<CommonRequestResult>>
  • 拒绝入群申请。仅群主和管理员可调用此方法。

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

    已废弃,请用 rejectGroupJoinRequest 代替。

    Parameters

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

        申请加群的用户 ID。

      • groupId: string

        群组 ID。

      • reason: string

        拒绝原因。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<CommonRequestResult>>

removeAdmin

  • 移除群管理员。仅群主可调用此方法。被取消管理员权限的用户会在 onGroupChange 的回调里收到 type: 'removeAdmin'。

    connection.removeAdmin({gorupId: 'gorupId', username: 'user1'})
    

    Parameters

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

    Returns Promise<AsyncResult<RemoveGroupAdminResult>>

removeGroupBlockMulti

  • 将成员批量移出群组黑名单。仅群主和管理员可调用此方法。被移出黑名单的成员会在 onGroupChange 的回调中收到 type: 'allow'。

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

    已废弃,请用 unblockGroupMembers 代替。

    Parameters

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

        群组 ID。

      • usernames: string[]

        要移除黑名单用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult[]>>

removeGroupBlockSingle

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

    connection.removeGroupBlockSingle({groupId: 'groupId'})
    
    deprecated

    已废弃,请用 unblockGroupMember 代替。

    Parameters

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

        群组 ID。

      • username: string

        要移除黑名单的成员用户 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult>>

Const removeGroupMember

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

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

    Parameters

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

    Returns Promise<AsyncResult<RemoveGroupMemberResult>>

Const removeGroupMembers

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

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

    Parameters

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

    Returns Promise<AsyncResult<RemoveGroupMemberResult[]>>

Const removeGroupWhitelistMember

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

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

    Parameters

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

        群组 ID。

      • userName: string

        将要移除白名单的成员 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult>>

removeMultiGroupMember

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

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

    已废弃,请用 removeGroupMembers 代替。

    Parameters

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

    Returns Promise<AsyncResult<RemoveGroupMemberResult[]>>

removeMute

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

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

    已废弃,请用 unmuteGroupMember 代替。

    Parameters

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

    Returns Promise<AsyncResult<UnmuteGroupMemberResult[]>>

removeSingleGroupMember

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

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

    已废弃,请用 removeGroupMember 代替。

    Parameters

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

    Returns Promise<AsyncResult<RemoveGroupMemberResult>>

rmUsersFromGroupWhitelist

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

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

    已废弃,请用 removeGroupWhitelistMember 代替。

    Parameters

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

        群组 ID。

      • userName: string

        将要移除白名单的成员 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult>>

setAdmin

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

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

    已废弃,请用 setGroupAdmin 代替。

    Parameters

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

    Returns Promise<AsyncResult<SetGroupAdminResult>>

Const setGroupAdmin

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

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

    Parameters

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

    Returns Promise<AsyncResult<SetGroupAdminResult>>

Const unblockGroupMember

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

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

    Parameters

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

        群组 ID。

      • username: string

        要移除黑名单的成员用户 ID。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult>>

Const unblockGroupMembers

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

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

    Parameters

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

        群组 ID。

      • usernames: string[]

        要移除黑名单用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void
        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

    Returns Promise<AsyncResult<GroupRequestResult[]>>

Const unmuteGroupMember

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

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

    Parameters

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

    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