QChatServerServiceInterface

调用方式:

qchat.qchatServer.createServer(options)

Hierarchy

QChatServerServiceInterface

Methods

acceptServerApply

acceptServerApply(options: AcceptServerApplyOptions): Promise<void>

同意服务器加入申请
申请人调用 applyServerJoin 申请加入服务器。拥有 “服务器申请权限” 的用户，收到 type = ESystemMessageType.serverMemberApply 的圈组内置系统通知。随后，权限用户通过该接口同意申请

影响范围
- 同意申请后，服务器内所有用户收到 type = ESystemMessageType.serverMemberApplyAccept 的圈组内置系统通知
- 申请人收到 type = ESystemMessageType.serverEnterLeave 的的圈组内置系统通知
example
```
qchat.qchatServer.acceptServerApply({
 // 圈组服务器ID
 "serverId": "10390563",
 // 申请人accid
 "accid": "zk2",
 "recordInfo": {
   // 系统通知的 requestId
   "requestId": "14159101"
 }
})
```
Parameters
- options: AcceptServerApplyOptions
Returns Promise<void>

acceptServerInvite

acceptServerInvite(options: AcceptServerInviteOptions): Promise<void>

接受进入服务器邀请
管理员调用 inviteServerMembers 邀请用户进入服务器被邀请人收到 type = ESystemMessageType.serverMemberInvite 的圈组内置系统通知。随后，被邀请人通过该接口同意申请

影响范围
- 服务器内所有成员收到 type = ESystemMessageType.serverMemberInviteAccept 的圈组内置系统通知
- 接收邀请者收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
example
```
qchat.qchatServer.acceptServerInvite({
 // 圈组服务器ID
 "serverId": "10390564",
 // 邀请者accid
 "accid": "zk1",
 "recordInfo": {
   // 系统通知的 requestId
   "requestId": "14159103"
 }
})
```
Parameters
- options: AcceptServerInviteOptions
Returns Promise<void>

applyServerJoin

applyServerJoin(options: ApplyServerJoinOptions): Promise<QChatServerApplyRecordInfo>

申请加入服务器。如果申请人被封禁 QChatServerServiceInterface.banServerMember，调用此函数会收到 403 错误
影响范围
- 若服务器模式为申请者可以直接加入
  - 申请人加入服务器
  - 服务器内所有成员收到 type = ESystemMessageType.serverMemberApplyDone 的圈组内置系统通知
  - 申请人收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
- 若服务器模式为申请者需要同意才可以加入
  - 服务器内拥有 “服务器申请权限” 的用户，会收到 type = ESystemMessageType.serverMemberApply 的圈组内置系统通知
  - 拥有权限的用户，通过 acceptServerApply同意申请，或者通过 rejectServerApply 拒绝申请
Parameters
- options: ApplyServerJoinOptions
Returns Promise<QChatServerApplyRecordInfo>

banServerMember

banServerMember(options: BanServerMemberOptions): Promise<void>

拥有封禁他人权限（QChatRoleAuth.banServerMember）的用户可调用 banServerMember 封禁服务器成员。
- 不在服务器内的成员不能通过此方法禁止
- 游客也无法通过此方法禁止
影响范围
- 被封禁的成员将直接被踢出服务器，且不能再申请加入服务器或被邀请加入服务器。
- 服务器内所有成员收到 type = ESystemMessageType.serverMemberKick 的圈组内置系统通知
- 被封禁者收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
Parameters
- options: BanServerMemberOptions
Returns Promise<void>

createServer

createServer(options: CreateServerOptions): Promise<ServerInfo>

创建服务器，返回值为服务器基本信息
影响范围
- 服务器创建者，及多端同步账号，收到 type = ESystemMessageType.serverCreate 的圈组内置系统通知
- 服务器创建者，及多端同步账号，收到 type = ESystemMessageType.serverEnterLeave 的的圈组内置系统通知
example
```
const serverInfo = await qchat.qchatServer.createServer({
   name: '美食圈',
   // 邀请用户加入时，是否需要用户同意。0: 需要，1: 不需要
   inviteMode: 0,
   // 申请加入时，是否需要管理员同意。0: 不需要，1: 需要
   applyMode: 1
})
```
Parameters
- options: CreateServerOptions
Returns Promise<ServerInfo>

deleteServer

deleteServer(options: DeleteServerOptions): Promise<void>

删除服务器。仅服务器创建者可删除服务器。
影响范围
- 服务器内所有成员收到 type = ESystemMessageType.serverRemove 的圈组内置系统通知
- 服务器内所有成员收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
Parameters
- options: DeleteServerOptions
Returns Promise<void>

enterAsVisitor

enterAsVisitor(options: { serverIds: string[] }): Promise<{ failedServers: string[] }>

以游客身份加入服务器。请查看文档：游客功能
注: 目前 IM 服务端限定最多加 10 个

影响范围
- 以游客身份加入服务器并不会触发圈组内置系统回调
Parameters
- options: { serverIds: string[] }
  - serverIds: string[]
Returns Promise<{ failedServers: string[] }>

generateInviteCode

generateInviteCode(options: QChatServerGenerateInviteCodeOptions): Promise<QChatServerInviteCode>

生成一个邀请码。可以通过 ttl 设置邀请码有效时间。若不设置，默认有效期为 30 天。

有效期内，任何人都可以通过 joinByInviteCode 加入服务器。过期后，邀请码失效。
example
```
const res = await qchat.qchatServer.generateInviteCode({
 "serverId": "10390581",
 "ttl": 86400000
})

// 将 Code 发给其它端后，其它端加入频道
await qchat.qchatServer.joinByInviteCode({
   "serverId": res.serverId,
   "inviteCode": res.inviteCode,
   "ps": "xxx"
})
```
Parameters
- options: QChatServerGenerateInviteCodeOptions
Returns Promise<QChatServerInviteCode>

getBannedMembersByPage

getBannedMembersByPage(options: GetBannedMembersByPageOptions): Promise<GetBannedMembersByPageResult>

分页获取封禁成员。从 timetag 开始逆序查找。查找 createTime 小于 timetag 的封禁记录，直到查完，或者达到 limit。

若 timetag = 0，表示从服务器当前时间开始逆序查找

example

const serverId = '10390581'
const limit = 10
let list = []

// 第一页。timetag设置为0，表示最新时间
let res = await qchat.qchatServer.getBannedMembersByPage({
 "serverId": serverId,
 "timetag": 0,
 "limit": limit
})

list = [...list, ...res.datas]
while (res.listQueryTag.hasMore) {
 res = await qchat.qchatServer.getBannedMembersByPage({
   "serverId": serverId,
   "timetag": res.listQueryTag.nextTimetag,
   "limit": limit
 })
 list = [...list, ...res.datas]
}

Parameters

options: GetBannedMembersByPageOptions

Returns Promise<GetBannedMembersByPageResult>

getInviteApplyRecordOfSelf

getInviteApplyRecordOfSelf(options: QChatServerGetInviteApplyRecordOfSelfOptions): Promise<QChatServerInviteApplyRecord[]>

查询自己申请加入服务器，以及被邀请加入服务器的历史记录。

初次请求时，cursor 可以不填写。下次请求时，使用返回纪录的 recordId 作为 cursor。

Parameters
- options: QChatServerGetInviteApplyRecordOfSelfOptions
Returns Promise<QChatServerInviteApplyRecord[]>

getInviteApplyRecordOfServer

getInviteApplyRecordOfServer(options: QChatServerGetInviteApplyRecordOfServerOptions): Promise<QChatServerInviteApplyRecord[]>

查询某服务器下的申请和邀请进入的历史记录

Parameters
- options: QChatServerGetInviteApplyRecordOfServerOptions
Returns Promise<QChatServerInviteApplyRecord[]>

getServerMembers

getServerMembers(options: GetServerMembersOptions): Promise<MemberInfo[]>

根据用户ID，查询服务器下该用户的具体信息

example

const members = await qchat.qchatServer.getServerMemberInfo({
  "accids": [
    {
      "accid": "autotest1",
      "serverId": "10390582"
    },
    {
      "accid": "autotest2",
      "serverId": "10390582"
    }
  ]
})

Parameters

options: GetServerMembersOptions

Returns Promise<MemberInfo[]>

getServerMembersByPage

getServerMembersByPage(options: GetServerMembersByPageOptions): Promise<GetServerMembersByPageResult>

分页查询服务器成员。从 timetag 开始逆序查找。查找 createTime 小于 timetag 的成员，直到查完，或者达到 limit。

若 timetag = 0，表示从服务器当前时间开始逆序查询。注意，被ban成员不会被查到

example

const serverId = '10390581'
const limit = 10
let list = []

// 第一页。timetag设置为0，表示最新时间
let res = await qchat.qchatServer.getServerMembersByPage({
 "serverId": serverId,
 "timetag": 0,
 "limit": limit
})

list = [...list, ...res.datas]
while (res.listQueryTag.hasMore) {
 res = await qchat.qchatServer.getServerMembersByPage({
   "serverId": serverId,
   "timetag": res.listQueryTag.nextTimetag,
   "limit": limit
 })
 list = [...list, ...res.datas]
}

Parameters

options: GetServerMembersByPageOptions

Returns Promise<GetServerMembersByPageResult>

getServers

getServers(options: GetServersOptions): Promise<ServerInfo[]>

根据服务器ID，查询服务器信息
- 可以查询当前账号并未加入的服务器
- 只有存在的服务器才会在结果中返回
Parameters
- options: GetServersOptions
Returns Promise<ServerInfo[]>

getServersByPage

getServersByPage(options: GetServersByPageOptions): Promise<GetServersByPageResult>

分页查询服务器列表。

该函数只会查询当前账号加入的服务器
查询从 options.timestamp 开始查，查找 createTime 小于 options.timestamp 的服务器，直到查完，或者达到 options.limit

example

const limit = 10
let list = []

// 第一页。timetag设置为0，表示最新时间
let res = await qchat.qchatServer.getServersByPage({
 "timestamp": 0,
 "limit": limit
})

list = [...list, ...res.datas]
while (res.listQueryTag.hasMore) {
 res = await qchat.qchatServer.getServersByPage({
   "timestamp": res.listQueryTag.nextTimetag,
   "limit": limit
 })
 list = [...list, ...res.datas]
}

Parameters

options: GetServersByPageOptions

Returns Promise<GetServersByPageResult>

inviteServerMembers

inviteServerMembers(options: InviteServerMembersOptions): Promise<InviteServerMembersResult>

邀请用户进入服务器
影响范围
- 若服务器邀请模式为无须同意
  - 被邀请人加入服务器
  - 服务器内所有成员收到 type = ESystemMessageType.serverMemberInviteDone 的圈组内置系统通知
  - 被邀请者收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
- 若服务器邀请模式为需要同意
  - 被邀请者收到 type = ESystemMessageType.serverMemberInvite 的圈组内置系统通知
  - 被邀请者通过 QChatServerServiceInterface.acceptServerInvite，或者 QChatServerServiceInterface.rejectInviteServer 回应
Parameters
- options: InviteServerMembersOptions
Returns Promise<InviteServerMembersResult>

joinByInviteCode

joinByInviteCode(options: QChatServerJoinByInviteCodeOptions): Promise<void>

根据邀请码加入服务器。如果邀请码过期，会收到 508 错误
影响范围
- 无论服务器申请模式如何，通过邀请码都可以直接加入服务器
- 服务器内所有成员收到 type = ESystemMessageType.serverMemberJoinByInviteCode 的圈组内置系统通知
- 申请者收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
example
```
qchat.qchatServer.joinByInviteCode({
 "serverId": "10390581",
 "inviteCode": "2F027WFKEN",
 "ps": "xxx"
})
```
Parameters
- options: QChatServerJoinByInviteCodeOptions
Returns Promise<void>

kickServerMembers

kickServerMembers(options: KickServerMembersOptions): Promise<void>

踢除服务器成员
影响范围
- 服务器内成员收到 type = ESystemMessageType.serverMemberKick 的圈组内置系统通知
- 被踢者收到 type = ESystemMessageType.serverEnterLeave 的圈组内置系统通知
Parameters
- options: KickServerMembersOptions
Returns Promise<void>

leaveAsVisitor

leaveAsVisitor(options: { serverIds: string[] }): Promise<{ failedServers: string[] }>

以游客身份离开服务器。请查看文档：游客功能
注: 目前 IM 服务端限定最多加 10 个

影响范围
- 以游客身份离开服务器并不会触发圈组内置系统回调
Parameters
- options: { serverIds: string[] }
  - serverIds: string[]
Returns Promise<{ failedServers: string[] }>

leaveServer

leaveServer(options: LeaveServerOptions): Promise<void>

主动离开服务器。服务器创建者离群会报 403 错误。
影响范围
- 服务器内成员收到 type = ESystemMessageType.serverMemberLeave 的内置系统通知
- 主动离群者收到 type = ESystemMessageType.serverEnterLeave 的内置系统通知
Parameters
- options: LeaveServerOptions
Returns Promise<void>

markRead

markRead(options: QChatServerMarkReadOptions): Promise<QChatServerMarkReadResult>

清空服务器下所有频道的未读数

Parameters
- options: QChatServerMarkReadOptions
Returns Promise<QChatServerMarkReadResult>

rejectInviteServer

rejectInviteServer(options: RejectServerInviteOptions): Promise<void>

拒绝入群邀请
管理者通过 inviteServerMembers 邀请用户进入服务器后，被邀请人可以通过该函数拒绝邀请

影响范围
- 邀请者收到 type = ESystemMessageType.serverMemberInviteReject 的圈组内置系统通知
Parameters
- options: RejectServerInviteOptions
Returns Promise<void>

rejectServerApply

rejectServerApply(options: RejectServerApplyOptions): Promise<void>

拒绝入群申请
申请人调用 applyServerJoin 申请加入服务器后，群管理者可以通过该函数拒绝申请

影响范围
- 申请人收到 type = ESystemMessageType.serverMemberApplyReject 的圈组内置系统通知
Parameters
- options: RejectServerApplyOptions
Returns Promise<void>

serverMemberSearchByPage

serverMemberSearchByPage(options: ServerMemberSearchByPageOptions): Promise<MemberInfo[]>

通过keyword，搜索服务器内的群成员

example

const res = await qchat.qchatServer.serverMemberSearchByPage({
  "serverId": "10390605",
  "keyword": "abc",
  "limit": 100
})

Parameters

options: ServerMemberSearchByPageOptions

Returns Promise<MemberInfo[]>

serverSearchByPage

serverSearchByPage(options: ServerSearchByPageOptions): Promise<ServerSearchByPageResult>

通过关键词、时间范围、服务器类型等条件，搜索所有符合要求的服务器

example

const res = await qchat.qchatServer.serverSearchByPage({
  "keyword": "网易云信",
  "startTime": 0,
  "endTime": 1698911671817,
  "limit": 100,
  // 即 createServer 时设置的 searchType
  "serverType": [0, 1],
  "order": "ASC",
  // square 表示全局搜索服务器
  // person 表示搜索个人加入的服务器
  "searchType": "square",
  "sort": "createTime"
})

Parameters

options: ServerSearchByPageOptions

Returns Promise<ServerSearchByPageResult>

subscribeAllChannel

subscribeAllChannel(options: SubscribeAllChannelOptions): Promise<SubscribeAllChannelResult>

订阅服务器下的所有频道。

圈组订阅机制请查看文档: 圈组订阅机制

Parameters
- options: SubscribeAllChannelOptions
Returns Promise<SubscribeAllChannelResult>

subscribeAsVisitor

subscribeAsVisitor(options: NIMEQChatServerSubscribeAsVisitorOptions): Promise<{ failedServers: string[] }>

以游客身份订阅服务器

圈组订阅机制请查看文档: 圈组订阅机制

Parameters
- options: NIMEQChatServerSubscribeAsVisitorOptions
Returns Promise<{ failedServers: string[] }>

subscribeServer

subscribeServer(options: SubscribeServerOptions): Promise<void | SubscribeServerResult>

订阅服务器的人员变更、权限变更等消息

Parameters
- options: SubscribeServerOptions
Returns Promise<void | SubscribeServerResult>

unbanServerMember

unbanServerMember(options: UnbanServerMemberOptions): Promise<void>

解封服务器成员。解除封禁后，需要重新通过申请，或者邀请的方式加入服务器

Parameters
- options: UnbanServerMemberOptions
Returns Promise<void>

updateMyMemberInfo

updateMyMemberInfo(options: UpdateMyMemberInfoOptions): Promise<MemberInfo>

修改自己在服务器中的成员信息

#example

const res = await qchat.qchatServer.updateMyMemberInfo({
  "serverId": "10390609",
  "accid": qchat.account,
  "nick": "my nick",
  "avatar": "https://avatar.com/xxx.png",
  "ext": "extension"
})

Parameters

options: UpdateMyMemberInfoOptions

Returns Promise<MemberInfo>

updateServer

updateServer(options: UpdateServerOptions): Promise<ServerInfo>

更新服务器信息。仅服务器创建者可更新服务器信息。
影响范围
- 服务器内所有成员收到 type = ESystemMessageType.serverUpdate 的圈组内置系统通知
Parameters
- options: UpdateServerOptions
Returns Promise<ServerInfo>

updateServerMemberInfo

updateServerMemberInfo(options: UpdateServerMemberInfoOptions): Promise<MemberInfo>

修改他人服务器成员信息。仅管理员可操作，管理员用于修改他人在服务器中的成员信息
影响范围
- 服务器内成员收到 type = ESystemMessageType.serverMemberUpdate 的内置系统通知
Parameters
- options: UpdateServerMemberInfoOptions
Returns Promise<MemberInfo>

Hierarchy

Index

Methods

Methods

acceptServerApply

影响范围

Parameters

options: AcceptServerApplyOptions

Returns Promise<void>

acceptServerInvite

影响范围

Parameters

options: AcceptServerInviteOptions

Returns Promise<void>

applyServerJoin

影响范围

Parameters

options: ApplyServerJoinOptions

Returns Promise<QChatServerApplyRecordInfo>

banServerMember

影响范围

Parameters

options: BanServerMemberOptions

Returns Promise<void>

createServer

影响范围

Parameters

options: CreateServerOptions

Returns Promise<ServerInfo>

deleteServer

影响范围

Parameters

options: DeleteServerOptions

Returns Promise<void>

enterAsVisitor

影响范围

Parameters

options: { serverIds: string[] }

serverIds: string[]

Returns Promise<{ failedServers: string[] }>

generateInviteCode

Parameters

options: QChatServerGenerateInviteCodeOptions

Returns Promise<QChatServerInviteCode>

getBannedMembersByPage

Parameters

options: GetBannedMembersByPageOptions

Returns Promise<GetBannedMembersByPageResult>

getInviteApplyRecordOfSelf

Parameters

options: QChatServerGetInviteApplyRecordOfSelfOptions

Returns Promise<QChatServerInviteApplyRecord[]>

getInviteApplyRecordOfServer

Parameters

options: QChatServerGetInviteApplyRecordOfServerOptions

Returns Promise<QChatServerInviteApplyRecord[]>

getServerMembers

Parameters

options: GetServerMembersOptions

Returns Promise<MemberInfo[]>

getServerMembersByPage

Parameters

options: GetServerMembersByPageOptions

Returns Promise<GetServerMembersByPageResult>

getServers

Parameters

options: GetServersOptions

Returns Promise<ServerInfo[]>

getServersByPage

Parameters

options: GetServersByPageOptions

Returns Promise<GetServersByPageResult>

inviteServerMembers

影响范围

Parameters

options: InviteServerMembersOptions

Returns Promise<InviteServerMembersResult>

joinByInviteCode

影响范围

Parameters