接受入群邀请。群组成员邀请用户入群时，用户可调用该方法接受邀请。邀请者会在 onGroupEvent 的回调里收到 operation: 'acceptInvite'，加入成功之后群成员会在 onGroupEvent 的回调里收到 operation: 'memberPresence'。
connection.acceptGroupInvite({invitee: 'myUserId', groupId: 'groupId'})
群组 ID。
被邀请用户的用户 ID。
同意用户加入群。仅群主和管理员可调用此方法。加入群组的用户会在 onGroupEvent 的回调里收到 operation: 'acceptRequest'。
connection.acceptGroupJoinRequest({applicant: 'user1', groupId: 'groupId'})
申请加群的用户 ID。
群组 ID。
添加白名单。白名单里的成员可以在群禁言之后继续发言。仅群组管理员及以上身份可调用此方法。添加到白名单的成员会在 onGroupEvent 的回调里收到 operation: 'addUserToAllowlist'。
connection.addUsersToGroupAllowlist({groupId: 'groupId'})
群组 ID。
将要加入白名单的成员 ID 数组。
将单个成员加入群组黑名单。仅群主和管理员可调用此方法。添加到黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'removeMember'。
connection.blockGroupMember({groupId: 'groupId', username: 'user1'})
群组 ID。
将要添加到黑名单的用户id。
批量添加成员至群组黑名单。仅群组管理员可调用此方法。添加到黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'removeMember'。
connection.blockGroupMembers({usernames: ['user1', 'user2'], groupId: 'groupId'})
群组 ID。
要加入群组黑名单的成员用户 ID 数组。
屏蔽群组消息。该方法只对移动终端有效。
connection.blockGroupMessages({groupId: 'groupId'})
群组 ID。
转让群组。仅群主可调用此方法。群成员会在 onGroupEvent 回调里收到 operation:'changeOwner'。
connection.changeGroupOwner({groupId: 'groupId', newOwner: 'user1'})
群组 ID。
新群主。
创建群组。
connection.createGroup({
data: {
groupname: 'groupname',
desc: 'this is my group',
members: ['user1', 'user2'],
public: true,
approval: false,
allowinvites: true,
inviteNeedConfirm: false,
ext: {info: 'group info'}
}
})
群组信息。
是否允许群成员邀请其他人进群。true：允许；false：不允许。
加群是否需要管理员审批。- true：需要；- false：不需要。
群组描述。
群组详情扩展，可以采用 JSON 格式，以包含更多群信息。
群组名称。
受邀人加入群组前是否需接受入群邀请。
true ：需受邀人确认入群邀请。默认值为 true。false：受邀人直接加入群组，无需确认入群邀请。群组最大成员数。
群成员 ID 数组，这些用户会被直接加入群组，在 onGroupEvent 回调里收到 operation:'directJoined'。
是否为公开群，公开群：其他人可以调用 listGroups 查询到的群组。- true：公开群；- false：非公开群。
删除群共享文件。
connection.deleteGroupSharedFile({groupId: 'groupId', fileId: 'fileId'})
共享文件 ID。
群组 ID。
解散群组。仅群主可调用此方法。群组成员会在 onGroupEvent 的回调中收到 operation:'destroy'。
connection.destroyGroup({groupId: 'groupId'})
群组 ID。
设置全员禁言。仅群组管理员及以上身份可调用此方法。群组成员会在 onGroupEvent 的回调里收到 operation: 'muteAllMembers'
connection.disableSendGroupMsg({groupId: 'groupId'})
群组 ID。
下载群文件。
connection.downloadGroupSharedFile({groupId: 'groupId', fileId: 'fileId', onFileDownloadComplete: (data)=>{console.log(data)}})
共享文件 ID。
群组 ID。
下载文件需要的密钥。
解除全员禁言。仅群组管理员及以上身份可调用此方法。群组成员会在 onGroupEvent 的回调中收到 operation: 'unmuteAllMembers'。
connection.enableSendGroupMsg({groupId: 'groupId'})
群组 ID。
获取群公告。
connection.fetchGroupAnnouncement({groupId: 'groupId'})
群组 ID。
获取群组下所有管理员。
connection.getGroupAdmin({groupId: 'groupId'})
群组 ID。
获取群组白名单列表。仅群组管理员及以上身份可调用此方法。
connection.getGroupAllowlist({groupId: 'groupId'})
群组 ID。
获取群组黑名单。
connection.getGroupBlocklist({groupId: 'groupId'})
群组 ID。
获取群组详情。
connection.getGroupInfo({groupId: groupId})
群组 ID，或者群组 ID 列表。
查询哪些成员读取了群组消息。[增值功能]仅旗舰版及以上支持，具体见 pricing。
connection.getGroupMsgReadUser({groupId: 'groupId', msgId: 'msgId'})
群组 ID。
要查询的消息 ID。
获取群组的禁言列表。 仅群组管理员及以上身份可调用此方法。
connection.getGroupMutelist({groupId: 'groupId'})
群组 ID。
群组 ID。
当前页码，从 1 开始。
每页返回的成员数，最大值是 10。
获取用户加入的所有群组。
是否需要群组成员数。
true：是；
（默认）false：否。
是否需要当前用户在群组中的角色。
true：是；
（默认）false：否。
若设置了 needAffiliations 或 needAffiliations 参数，当前页码 (pageNum)从 0 开始。
不设置这两个参数，分页获取时，当前页码 （pageNum）从 1 开始。
若设置了 needAffiliations 或 needAffiliations 参数，每页获取的群组上限（pageSize）为 20。
不设置这两个参数，分页获取时，每页获取的群组上限(pageSize)为 500。
分页获取公开群。
connection.getPublicGroups({limit: 20, cursor: null})
游标。如果数据还有下一页，该方法的返回值会包含此字段，传递此字段可获取下一页的数据，为 null 时获取第一页数据。
每页返回的公开群组数。
邀请用户加群。 群组创建时 inviteNeedConfirm:true，被邀请的用户会在 onGroupEvent 的回调中收到 operation: 'inviteToJoin'。 群组创建时 inviteNeedConfirm:false，被邀请的用户会在 onGroupEvent 的回调中收到 operation: 'directJoined'。
connection.inviteUsersToGroup({groupId: 'groupId', users: ['user1', 'user2']})
群组 ID。
被邀请用户 ID 数组。
检查当前用户是否在群组白名单中。app admin 可查询所有用户；app user 可查询自己。
connection.isInGroupAllowlist({groupId: 'groupId', userName: 'user1'})
群组 ID.
要查询的用户 ID。
申请加入群组。群主和管理员会在 onGroupEvent 的回调中收到 operation:'requestToJoin'。
connection.joinGroup({groupId: 'groupId', message: 'I want to join the group'})
群组 ID。
请求附加信息。
离开群组。群组成员会在 onGroupEvent 的回调中收到 operation: 'memberAbsence'。
connection.leaveGroup({groupId: 'groupId'})
群组 ID。
分页列出群组的所有成员。
connection.listGroupMembers({pageNum: 1, pageSize: 20, groupId: 'groupId'})
群组 ID。
当前页码，从 1 开始。
每页返回的成员数，最大值是 1000。
修改群信息。仅群组管理员可调用此方法。
connection.modifyGroup({groupId: 'groupId', groupName: 'groupName', description:'description', ext: {info: 'group info'}})
群组描述。
群组详情扩展，可以采用 JSON 格式，以包含更多群信息。
群组 ID。
群组名称。
将一个或多个群组成员禁言。仅群主和管理员可调用此方法。禁言的成员和其他成员会在 onGroupEvent 的回调中收到 operation:'muteMember'。
connection.muteGroupMember({username: 'user1' || ['user1', 'user2'], muteDuration: -1, groupId: 'groupId'})
群组 ID。
禁言时长，单位毫秒。如果是 -1 代表永久。
禁言的群成员 ID。
拒绝入群邀请。群组成员邀请用户入群时，用户可调用该方法拒绝邀请。
connection.rejectGroupInvite({invitee: 'myUserId', groupId: 'groupId'})
群组 ID。
被邀请者的用户 ID。
拒绝入群申请。仅群主和管理员可调用此方法。
connection.rejectGroupJoinRequest({applicant: 'user1', groupId: 'groupId', reason: 'I do not like you'})
申请加群的用户 ID。
群组 ID。
拒绝原因。
移除群管理员。仅群主可调用此方法。被取消管理员权限的用户会在 onGroupEvent 的回调里收到 operation: 'removeAdmin'。
connection.removeGroupAdmin({groupId: 'groupId', username: 'user1'})
群组 ID。
移除管理员权限的用户 ID。
移除白名单。仅群组管理员及以上身份可调用此方法。移除白名单的用户会在 onGroupEvent 的回调中收到 operation:'removeAllowlistMember'。
connection.removeGroupAllowlistMember({groupId: 'groupId', userName: 'user1'})
群组 ID。
将要移除白名单的成员 ID。
将群成员移出群组。仅群主和管理员可调用此方法。被移出的成员会在 onGroupEvent 的回调中收到 operation:'removeMember'，其他群成员会在 onGroupEvent 的回调中收到 operation:'memberAbsence'。
connection.removeGroupMember({groupId: 'groupId', username: 'user1'})
群组 ID。
要移除成员 ID。
将多个群成员移出群组。仅群主和管理员可调用此方法。被移出的成员会在 onGroupEvent 的回调中收到 operation:'removeMember'，其他群成员会在 onGroupEvent 的回调中收到 operation:'memberAbsence'。
connection.removeGroupMembers({groupId: 'groupId', users: ['user1', 'user2']})
群组 ID。
要移出的成员 ID 数组。
设置群管理员。仅群主可调用此方法。设置为管理员的用户会在 onGroupEvent 的回调里收到 operation: 'setAdmin'。
connection.setGroupAdmin({groupId: 'groupId', username: 'user1'})
群组 ID。
设为管理员的用户 ID。
将单个成员从群组黑名单移除。仅群组管理员可调用此方法。移除黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'unblockMember'。
connection.unblockGroupMember({groupId: 'groupId', username: 'user'})
群组 ID。
要移除黑名单的成员用户 ID。
将成员批量移除群组黑名单。仅群主和管理员可调用此方法。移除黑名单的成员会在 onGroupEvent 的回调中收到 operation: 'unblockMember'。
connection.unblockGroupMembers({groupId: 'groupId', usernames: ['user1', 'user2']})
群组 ID。
要移除黑名单用户 ID 数组。
解除禁言。仅群主和管理员可调用此方法。解除禁言的用户和其他用户会在 onGroupEvent 的回调里收到 operation: 'unmuteMember'。
connection.unmuteGroupMember({groupId: 'groupId', username: 'user1' || ['user1', 'user2']})
群组 ID。
解除禁言的用户 ID。
更新群公告。
connection.updateGroupAnnouncement({groupId: 'groupId', announcement: 'hello'})
群公告。
群组 ID。
上传群组共享文件。
connection.uploadGroupSharedFile({groupId: 'groupId', file: 'file object', onFileUploadProgress: onFileUploadProgress, onFileUploadComplete: onFileUploadComplete,onFileUploadError:onFileUploadError,onFileUploadCanceled:onFileUploadCanceled})
上传的文件对象。
群组 ID。
上传取消的回调。
上传完成的回调。
上传失败的回调。
上传进度的回调。
Generated using TypeDoc
Group contains APIs for group-related operations.