Channel | Chat SDK for WEB

Channel contains the APIs for channel operations.

Index

Functions

acceptChannelInvite

acceptChannelInvite(this: Connection, params: { channelId: string; inviter: string; serverId: string }): Promise<AsyncResult<ChannelInfo>>

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

createChannel

createChannel(this: Connection, params: { categoryId?: string; description?: string; ext?: string; isPublic?: boolean; maxusers?: number; mode?: number; name: string; rtcChannelId?: string; serverId: string }): Promise<AsyncResult<ChannelInfo>>

创建频道。
仅社区所有者可以调用该方法。
```
connection.createChannel({
serverId: 'serverID',
isPublic: true,
name: 'channelName',
description: 'this is my channel',
ext: 'ext',
categoryId: 'categoryId',
mode: 1,
maxusers: 8,
rtcChannelId: 'rtcChannelId',
})
```
Parameters
- this: Connection
- params: { categoryId?: string; description?: string; ext?: string; isPublic?: boolean; maxusers?: number; mode?: number; name: string; rtcChannelId?: string; serverId: string }
  - Optional categoryId?: string
    
    频道分组 ID。
    
    如果该参数不传，默认将创建的频道添加到社区的默认频道分组中。
  - Optional description?: string
    
    频道描述。
  - Optional ext?: string
    
    频道的扩展字段。
  - Optional isPublic?: boolean
    是否为公开频道。
    
    （默认）true：公开频道。用户可以调用 getPublicChannels 方法查询公开频道。
    
    false：私密频道。
  - Optional maxusers?: number
    频道最大成员数量。
    文字频道：该参数的取值范围为 [1,2000]，默认值为 2000；
    
    语聊频道：该参数的取值范围为 [1,20]，默认值为 8。
  - Optional mode?: number
    频道类型：
    
    （默认）0: 文字频道
    
    1: 语聊频道
  - name: string
    
    频道名称。
  - Optional rtcChannelId?: string
    
    RTC 频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ChannelInfo>>

destroyChannel

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

删除频道。
仅社区所有者可调用该方法。
```
connection.destroyChannel({serverId: 'serverId', channelId: 'channelId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<void>

getChannelDetail

getChannelDetail(this: Connection, params: { channelId: string; serverId: string }): Promise<AsyncResult<ChannelInfo>>

获取频道详情。
```
connection.getChannelDetail({serverId: 'serverId', channelId: 'channelId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ChannelInfo>>

getChannelMembers

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

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

getChannelMutelist

getChannelMutelist(this: Connection, params: { channelId: string; serverId: string }): Promise<AsyncResult<ChannelMuteMemberListResult>>

查询指定频道的禁言列表。
仅社区所有者和管理员可调用该方法。
```
connection.getChannelMutelist({channelId: 'channelId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ChannelMuteMemberListResult>>

getPrivateChannels

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

分页获取社区中的私密频道列表。
SDK 按照私密频道创建时间的正序返回。
```
connection.getPrivateChannels({serverId:'serverId',pageSize: 10,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<ChannelInfoListResult>>

getPublicChannels

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

分页获取社区下的公开频道列表。
SDK 按公开频道的创建时间的正序获取。
```
connection.getPublicChannels({serverId:'serverId'pageSize: 10,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<ChannelInfoListResult>>

inviteUserToChannel

inviteUserToChannel(this: Connection, params: { channelId: string; inviteMessage?: string; serverId: string; userId: string }): Promise<void>

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

isInChannel

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

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

joinChannel

joinChannel(this: Connection, params: { channelId: string; serverId: string }): Promise<AsyncResult<ChannelInfo>>

加入频道。
```
connection.joinChannel({serverId: 'serverId', channelId: 'channelId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ChannelInfo>>

leaveChannel

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

退出频道。
退出频道的成员不会再收到频道消息。

社区内的默认频道不允许成员主动退出。
```
connection.leaveChannel({serverId: 'serverId', channelId: 'channelId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<void>

muteChannelMember

muteChannelMember(this: Connection, params: { channelId: string; duration: number; serverId: string; userId: string }): Promise<void>

禁言指定的频道成员。
仅社区所有者和管理员可调用该方法。
```
connection.muteChannelMember({serverId: 'serverId',channelId: 'channelId',userId: 'userId'})
```
Parameters
- this: Connection
- params: { channelId: string; duration: number; serverId: string; userId: string }
  - channelId: string
    
    频道 ID。
  - duration: number
    
    禁言时长，单位为毫秒。值为 -1 时表示永久禁言。
  - serverId: string
    
    社区 ID。
  - userId: string
    
    要禁言的成员的用户 ID。
Returns Promise<void>

rejectChannelInvite

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

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

removeChannelMember

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

移除频道成员。
社区所有者可将频道中的所有成员移出，社区管理员只能将普通成员移出频道。

社区内的默认频道不允许踢出成员。
```
connection.removeChannelMember({serverId: 'serverId', channelId: 'channelId',userId: 'userId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string; userId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
  - userId: string
    
    频道成员的用户 ID。
Returns Promise<void>

unmuteChannelMember

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

解除对指定频道成员的禁言。
仅社区所有者和管理员可调用该方法。
```
connection.muteChannelMember({serverId: 'serverId',channelId: 'channelId',userId: 'userId'})
```
Parameters
- this: Connection
- params: { channelId: string; serverId: string; userId: string }
  - channelId: string
    
    频道 ID。
  - serverId: string
    
    社区 ID。
  - userId: string
    
    要解除禁言的成员的用户 ID。
Returns Promise<void>

updateChannel

updateChannel(this: Connection, params: { channelId: string; description?: string; ext?: string; isPublic?: boolean; maxusers?: number; name?: string; rtcChannelId?: string; serverId: string }): Promise<AsyncResult<ChannelInfo>>

修改指定频道的属性信息。
仅社区所有者和管理员可调用该方法。
```
connection.updateChannel({
serverId: 'serverId',
channelId: 'channelId'
name: 'the channel name',
description: 'the channel description',
maxusers: 8,
isPublic: true,
rtcChannelId: 'rtcChannelId',
})
```
Parameters
- this: Connection
- params: { channelId: string; description?: string; ext?: string; isPublic?: boolean; maxusers?: number; name?: string; rtcChannelId?: string; serverId: string }
  - channelId: string
    
    频道 ID。
  - Optional description?: string
    
    频道描述。
  - Optional ext?: string
    
    频道扩展字段。
  - Optional isPublic?: boolean
    是否为公开频道。
    
    （默认）true：公开频道。用户可以调用 getPublicChannels 方法查询公开频道。
    
    false：私密频道。
  - Optional maxusers?: number
    
    频道成员上限。
  - Optional name?: string
    
    频道名称。
  - Optional rtcChannelId?: string
    
    RTC 频道 ID。
  - serverId: string
    
    社区 ID。
Returns Promise<AsyncResult<ChannelInfo>>

Index

Functions

Functions

acceptChannelInvite

Parameters

this: Connection

params: { channelId: string; inviter: string; serverId: string }

channelId: string

inviter: string

serverId: string

Returns Promise<AsyncResult<ChannelInfo>>

createChannel

Parameters

this: Connection

params: { categoryId?: string; description?: string; ext?: string; isPublic?: boolean; maxusers?: number; mode?: number; name: string; rtcChannelId?: string; serverId: string }

Optional categoryId?: string

Optional description?: string

Optional ext?: string

Optional isPublic?: boolean

Optional maxusers?: number

Optional mode?: number

name: string

Optional rtcChannelId?: string

serverId: string

Returns Promise<AsyncResult<ChannelInfo>>

destroyChannel

Parameters

this: Connection

params: { channelId: string; serverId: string }

channelId: string

serverId: string

Returns Promise<void>

getChannelDetail

Parameters

this: Connection

params: { channelId: string; serverId: string }

channelId: string

serverId: string

Returns Promise<AsyncResult<ChannelInfo>>

getChannelMembers

Parameters

this: Connection

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

channelId: string

Optional cursor?: string

Optional pageSize?: number

serverId: string

Returns Promise<AsyncResult<ChannelMemberListResult>>

getChannelMutelist

Parameters

this: Connection

params: { channelId: string; serverId: string }

channelId: string

serverId: string

Returns Promise<AsyncResult<ChannelMuteMemberListResult>>

getPrivateChannels

Parameters

this: Connection

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

Optional cursor?: string

Optional pageSize?: number

serverId: string

Returns Promise<AsyncResult<ChannelInfoListResult>>

getPublicChannels

Parameters

this: Connection

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

Optional cursor?: string

Optional pageSize?: number

serverId: string

Returns Promise<AsyncResult<ChannelInfoListResult>>

inviteUserToChannel

Parameters

this: Connection

params: { channelId: string; inviteMessage?: string; serverId: string; userId: string }

channelId: string

Optional inviteMessage?: string

serverId: string

userId: string

Returns Promise<void>