Server | Chat SDK for WEB

Server contains the APIs for server operations.

Functions

acceptServerInvite

acceptServerInvite(this: Connection, params: { inviter: string; serverId: string }): Promise<AsyncResult<ServerInfo>>

同意加入社区的邀请。
```
connection.acceptServerInvite({serverId: 'serverId',inviter: 'uid')
```
Parameters
- this: Connection
- params: { inviter: string; serverId: string }
  - inviter: string
    
    邀请人的用户 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerInfo>>

addServerTags

addServerTags(this: Connection, params: { serverId: string; tags: string[] }): Promise<AsyncResult<ServerTagList>>

添加社区标签。
仅社区所有者和管理员可以调用该方法。
```
connection.addServerTags({serverId: 'serverId',tags: ['A', 'B']})
```
Parameters
- this: Connection
- params: { serverId: string; tags: string[] }
  - serverId: string
    
    社区 ID。
  - tags: string[]
    
    要添加的社区标签名称列表。每个社区最多可添加 10 个标签。
Returns Promise<AsyncResult<ServerTagList>>

createServer

createServer(this: Connection, params: { backgroundUrl?: string; description?: string; ext?: string; icon?: string; isPublic?: boolean; name: string }): Promise<AsyncResult<ServerInfo>>

创建社区。
```
connection.createServer({name: 'serverName',icon: '',description: 'the description of the  server',ext: 'ext',isPublic:true, backgroundUrl:''})
```
Parameters
- this: Connection
- params: { backgroundUrl?: string; description?: string; ext?: string; icon?: string; isPublic?: boolean; name: string }
  - Optional backgroundUrl?: string
    
    社区背景 URL。
  - Optional description?: string
    
    社区描述。
  - Optional ext?: string
    
    社区扩展字段。
  - Optional icon?: string
    
    社区头像。
  - Optional isPublic?: boolean
    是否为公开社区：
    
    （默认）true：公开社区。用户可以调用 getServers 方法搜索公开社区。
    
    false：私密社区。
  - name: string
    
    社区名称。
Returns Promise<AsyncResult<ServerInfo>>

destroyServer

destroyServer(this: Connection, params: { serverId: string }): Promise<void>

销毁社区。
仅社区所有者可调用该方法。
```
connection.destroyServer({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    要销毁的社区的 ID。
Returns Promise<void>

getJoinedServers

getJoinedServers(this: Connection, params: { cursor?: string; pageSize?: number }): Promise<AsyncResult<ServerInfoList>>

分页获取当前用户加入的社区。
SDK 从指定的游标位置按照用户加入社区的正序查询。
```
connection.getJoinedServers({pageSize: '10',cursor: ''})
```
Parameters
- this: Connection
- params: { cursor?: string; pageSize?: number }
  - Optional cursor?: string
    
    开始获取数据的游标位置。首次调用方法时传空字符串，SDK 从最早加入的社区开始查询。
  - Optional pageSize?: number
    
    每页期望获取的社区数量。取值范围为 [1,20]，默认为 20。
Returns Promise<AsyncResult<ServerInfoList>>

getServerDetail

getServerDetail(this: Connection, params: { serverId: string }): Promise<AsyncResult<ServerInfo>>

获取社区详情。
```
connection.getServerDetail({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerInfo>>

getServerMembers

getServerMembers(this: Connection, params: { cursor?: string; pageSize?: number; serverId: string }): Promise<AsyncResult<ServerMemberData>>

分页获取社区成员列表。
SDK 按成员加入社区时间的正序查询。
```
connection.getServerMembers({serverId: 'serverId ',pageSize:20,cursor:'cursor'})
```
Parameters
- this: Connection
- params: { cursor?: string; pageSize?: number; serverId: string }
  - Optional cursor?: string
    
    开始获取数据的游标位置。首次调用该方法时传空字符串，SDK 从最早加入社区的成员开始查询。
  - Optional pageSize?: number
    
    每页期望获取的社区成员数量。取值范围为 [1,20]，默认为 20。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerMemberData>>

getServerRole

getServerRole(this: Connection, params: { serverId: string }): Promise<AsyncResult<ServerRole>>

获取当前用户在社区中的角色。
```
connection.getServerRole({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerRole>>

getServerTags

getServerTags(this: Connection, params: { serverId: string }): Promise<AsyncResult<ServerTagList>>

获取当前社区的标签列表。
```
connection.getServerTags({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerTagList>>

getServers

getServers(this: Connection, params: { cursor?: string; keyword: string; pageSize?: number; type?: "serverName" | "tagName" }): Promise<AsyncResult<ServerInfoList>>

根据关键字搜索公开社区。
SDK 按社区创建时间顺序查询。
```
connection.getServers({keyword: 'keyword',type:'serverName'})
```
Parameters
- this: Connection
- params: { cursor?: string; keyword: string; pageSize?: number; type?: "serverName" | "tagName" }
  - Optional cursor?: string
    
    开始获取数据的游标位置。首次调用方法时传空字符串，SDK 从最早创建的社区开始搜索。
  - keyword: string
    
    查询关键字，即社区名称或者社区标签名称。
  - Optional pageSize?: number
    
    每页期望返回的社区数量。取值范围为 [1,20]，默认为 20。
  - Optional type?: "serverName" | "tagName"
    查询类型。目前只支持按社区名称或社区标签名称查询，默认根据社区名称搜索。
    
    根据社区名称搜索，支持基于通过社区全名搜索和模糊搜索分页获取数据。若使用模糊搜索，你需要传入社区名称中最左侧的单个字或词汇，或包含该字或词汇的关键字。例如社区名称为 足球社区01，那么传入 足、足球 都可搜索出该社区，而使用 球 或 社区01 则搜索不到该社区。
    
    若根据标签名称搜索，需传入完整的标签名称，不支持模糊搜索。该类型查询直接获取带有该标签的所有社区，不支持分页查询。
Returns Promise<AsyncResult<ServerInfoList>>

inviteUserToServer

inviteUserToServer(this: Connection, params: { message?: string; serverId: string; userId: string }): Promise<void>

邀请用户加入社区。
```
connection.inviteUserToServer({serverId: 'serverId', userId: 'userId'})
```
Parameters
- this: Connection
- params: { message?: string; serverId: string; userId: string }
  - Optional message?: string
    
    邀请用户加入社区的消息。
  - serverId: string
    
    社区 ID。
  - userId: string
    
    受邀人的用户 ID。
Returns Promise<void>

isInServer

isInServer(this: Connection, params: { serverId: string }): Promise<AsyncResult<OperationResult>>

查询当前用户是否在社区中。
```
connection.isInServer({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<OperationResult>>

joinServer

joinServer(this: Connection, params: { serverId: string }): Promise<AsyncResult<ServerInfo>>

加入社区。
```
connection.joinServer({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerInfo>>

leaveServer

leaveServer(this: Connection, params: { serverId: string }): Promise<void>

退出社区。
社区所有者不支持退出社区操作，只能解散社区。
```
connection.leaveServer({serverId: 'serverId'})
```
Parameters
- this: Connection
- params: { serverId: string }
  - serverId: string
    
    社区 ID。
Returns Promise<void>

rejectServerInvite

rejectServerInvite(this: Connection, params: { inviter: string; serverId: string }): Promise<void>

拒绝加入社区的邀请。
```
connection.rejectServerInvite({serverId: 'serverId',inviter: 'uid')
```
Parameters
- this: Connection
- params: { inviter: string; serverId: string }
  - inviter: string
    
    邀请人的用户 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<void>

removeServerAdmin

removeServerAdmin(this: Connection, params: { serverId: string; userId: string }): Promise<void>

移除社区管理员。
仅社区所有者可调用该方法。
```
connection.removeServerAdmin({serverId: 'serverId',userId:'userId'})
```
Parameters
- this: Connection
- params: { serverId: string; userId: string }
  - serverId: string
    
    社区 ID。
  - userId: string
    
    要从社区管理员列表移除的用户 ID。
Returns Promise<void>

removeServerMember

removeServerMember(this: Connection, params: { serverId: string; userId: string }): Promise<void>

将指定成员踢出社区。
社区所有者可将所有成员踢出社区，社区管理员只能将普通成员踢出社区。
```
connection.removeServerMember({serverId: 'serverId',userId: 'userId})
```
Parameters
- this: Connection
- params: { serverId: string; userId: string }
  - serverId: string
    
    社区 ID。
  - userId: string
    
    要移出社区的成员的用户 ID。
Returns Promise<void>

removeServerTags

removeServerTags(this: Connection, params: { serverId: string; tagIds: string[] }): Promise<void>

移除社区标签。
仅社区所有者和管理员可以调用该方法。
```
connection.removeServerTags({serverId: 'serverId',tagIds: ['1', '2']})
```
Parameters
- this: Connection
- params: { serverId: string; tagIds: string[] }
  - serverId: string
    
    社区 ID。
  - tagIds: string[]
    
    要移除的社区标签 ID 的列表。
Returns Promise<void>

setServerAdmin

setServerAdmin(this: Connection, params: { serverId: string; userId: string }): Promise<void>

设置社区管理员。
仅社区所有者可调用该方法。
```
connection.setServerAdmin({serverId: 'serverId',userId:'userId'})
```
Parameters
- this: Connection
- params: { serverId: string; userId: string }
  - serverId: string
    
    社区 ID。
  - userId: string
    
    要设置为社区管理员的用户 ID。
Returns Promise<void>

updateServer

updateServer(this: Connection, params: { backgroundUrl?: string; description?: string; ext?: string; icon?: string; isPublic?: boolean; name?: string; serverId: string }): Promise<AsyncResult<ServerInfo>>

修改社区属性。
仅社区所有者和管理员可调用该方法。
```
connection.updateServer({serverId: 'serverId',name: 'name',icon: '',description: 'new description',isPublic: true, backgroundUrl: ''})
```
Parameters
- this: Connection
- params: { backgroundUrl?: string; description?: string; ext?: string; icon?: string; isPublic?: boolean; name?: string; serverId: string }
  - Optional backgroundUrl?: string
    
    社区背景 URL。
  - Optional description?: string
    
    社区描述。
  - Optional ext?: string
    
    社区自定义扩展参数，字符串格式。
  - Optional icon?: string
    
    社区头像 URL。
  - Optional isPublic?: boolean
    是否为公开社区。
    
    （默认）true：公开社区。用户可以调用 getServers 方法搜索公开社区。
    
    false：私密社区。
  - Optional name?: string
    
    社区名称。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ServerInfo>>

Index

Functions

Functions

acceptServerInvite

Parameters

this: Connection

params: { inviter: string; serverId: string }

inviter: string

serverId: string

Returns Promise<AsyncResult<ServerInfo>>

addServerTags

Parameters

this: Connection

params: { serverId: string; tags: string[] }

serverId: string

tags: string[]

Returns Promise<AsyncResult<ServerTagList>>

createServer

Parameters

this: Connection

params: { backgroundUrl?: string; description?: string; ext?: string; icon?: string; isPublic?: boolean; name: string }

Optional backgroundUrl?: string

Optional description?: string

Optional ext?: string

Optional icon?: string

Optional isPublic?: boolean

name: string

Returns Promise<AsyncResult<ServerInfo>>

destroyServer

Parameters

this: Connection

params: { serverId: string }

serverId: string

Returns Promise<void>

getJoinedServers

Parameters

this: Connection

params: { cursor?: string; pageSize?: number }

Optional cursor?: string

Optional pageSize?: number

Returns Promise<AsyncResult<ServerInfoList>>

getServerDetail

Parameters

this: Connection

params: { serverId: string }

serverId: string

Returns Promise<AsyncResult<ServerInfo>>

getServerMembers

Parameters

this: Connection

params: { cursor?: string; pageSize?: number; serverId: string }

Optional cursor?: string

Optional pageSize?: number

serverId: string

Returns Promise<AsyncResult<ServerMemberData>>

getServerRole

Parameters

this: Connection

params: { serverId: string }

serverId: string

Returns Promise<AsyncResult<ServerRole>>

getServerTags

Parameters

this: Connection

params: { serverId: string }

serverId: string

Returns Promise<AsyncResult<ServerTagList>>

getServers

Parameters

this: Connection

params: { cursor?: string; keyword: string; pageSize?: number; type?: "serverName" | "tagName" }

Optional cursor?: string

keyword: string

Optional pageSize?: number

Optional type?: "serverName" | "tagName"

Returns Promise<AsyncResult<ServerInfoList>>

inviteUserToServer

Parameters

this: Connection

params: { message?: string; serverId: string; userId: string }