Interface QChatServerServiceInterface

Hierarchy

QChatServerServiceInterface

Methods

acceptServerApply

acceptServerApply(options: AcceptServerApplyOptions): Promise<void>

同意加入服务器申请

Parameters
- options: AcceptServerApplyOptions
Returns Promise<void>

acceptServerInvite

acceptServerInvite(options: AcceptServerInviteOptions): Promise<void>

接受邀请

Parameters
- options: AcceptServerInviteOptions
Returns Promise<void>

applyServerJoin

applyServerJoin(options: ApplyServerJoinOptions): Promise<QChatServerApplyRecordInfo>

申请加入服务器

Parameters
- options: ApplyServerJoinOptions
Returns Promise<QChatServerApplyRecordInfo>

banServerMember

banServerMember(options: BanServerMemberOptions): Promise<void>

封禁服务器成员

Parameters
- options: BanServerMemberOptions
Returns Promise<void>

createServer

createServer(options: CreateServerOptions): Promise<ServerInfo>

创建服务器，返回服务器ID

Parameters
- options: CreateServerOptions
Returns Promise<ServerInfo>

deleteServer

deleteServer(options: DeleteServerOptions): Promise<void>

删除服务器

Parameters
- options: DeleteServerOptions
Returns Promise<void>

generateInviteCode

generateInviteCode(options: QChatServerGenerateInviteCodeOptions): Promise<QChatServerInviteCode>

生成一个邀请码

Parameters
- options: QChatServerGenerateInviteCodeOptions
Returns Promise<QChatServerInviteCode>

getBannedMembersByPage

getBannedMembersByPage(options: GetBannedMembersByPageOptions): Promise<GetBannedMembersByPageResult>

分页获取封禁成员

Parameters
- options: GetBannedMembersByPageOptions
Returns Promise<GetBannedMembersByPageResult>

getInviteApplyRecordOfSelf

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

查询我的申请和邀请进入的历史记录

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

getInviteApplyRecordOfServer

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

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

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

getServerMembers

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

查询服务器成员列表参数为 serverId | accid 列表，格式 serverId | accid

Parameters
- options: GetServerMembersOptions
Returns Promise<MemberInfo[]>

getServerMembersByPage

getServerMembersByPage(options: GetServerMembersByPageOptions): Promise<GetServerMembersByPageResult>

查询服务器成员列表（分页）

Parameters
- options: GetServerMembersByPageOptions
Returns Promise<GetServerMembersByPageResult>

getServers

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

查询服务器列表

Parameters
- options: GetServersOptions
Returns Promise<ServerInfo[]>

getServersByPage

getServersByPage(options: GetServersByPageOptions): Promise<GetServersByPageResult>

查询服务器列表（分页）

Parameters
- options: GetServersByPageOptions
Returns Promise<GetServersByPageResult>

inviteServerMembers

inviteServerMembers(options: InviteServerMembersOptions): Promise<InviteServerMembersResult>

邀请用户进入服务器

Parameters
- options: InviteServerMembersOptions
Returns Promise<InviteServerMembersResult>

joinByInviteCode

joinByInviteCode(options: QChatServerJoinByInviteCodeOptions): Promise<void>

根据邀请码加入服务器

Parameters
- options: QChatServerJoinByInviteCodeOptions
Returns Promise<void>

kickServerMembers

kickServerMembers(options: KickServerMembersOptions): Promise<void>

踢除服务器成员

Parameters
- options: KickServerMembersOptions
Returns Promise<void>

leaveServer

leaveServer(options: LeaveServerOptions): Promise<void>

主动离开服务器

Parameters
- options: LeaveServerOptions
Returns Promise<void>

markRead

markRead(options: QChatServerMarkReadOptions): Promise<QChatServerMarkReadResult>

清空服务器未读数

Parameters
- options: QChatServerMarkReadOptions
Returns Promise<QChatServerMarkReadResult>

rejectInviteServer

rejectInviteServer(options: RejectServerInviteOptions): Promise<void>

拒绝邀请

Parameters
- options: RejectServerInviteOptions
Returns Promise<void>

rejectServerApply

rejectServerApply(options: RejectServerApplyOptions): Promise<void>

拒绝加入服务器申请

Parameters
- options: RejectServerApplyOptions
Returns Promise<void>

serverMemberSearchByPage

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

搜索服务器成员

Parameters
- options: ServerMemberSearchByPageOptions
Returns Promise<MemberInfo[]>

serverSearchByPage

serverSearchByPage(options: ServerSearchByPageOptions): Promise<ServerSearchByPageResult>

检索服务器（广场/个人）

Parameters
- options: ServerSearchByPageOptions
Returns Promise<ServerSearchByPageResult>

subscribeAllChannel

subscribeAllChannel(options: SubscribeAllChannelOptions): Promise<SubscribeAllChannelResult>

订阅服务器下的频道的消息

Parameters
- options: SubscribeAllChannelOptions
Returns Promise<SubscribeAllChannelResult>

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>

修改自己服务器成员信息

Parameters
- options: UpdateMyMemberInfoOptions
Returns Promise<MemberInfo>

updateServer

updateServer(options: UpdateServerOptions): Promise<ServerInfo>

更新服务器

Parameters
- options: UpdateServerOptions
Returns Promise<ServerInfo>

updateServerMemberInfo

updateServerMemberInfo(options: UpdateServerMemberInfoOptions): Promise<MemberInfo>

修改他人服务器成员信息

Parameters
- options: UpdateServerMemberInfoOptions
Returns Promise<MemberInfo>