修改子频道
修改某个子频道的信息。
使用示例
async function demo() {let { data } = await client.channelApi.patchChannel(channelId, channel);}
::: warning 注意
- 要求操作人具有管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。
- 修改成功后,会触发子频道更新事件。
:::
参数说明
| 字段名 | 必填 | 类型 | 描述 |
|---|---|---|---|
| channelId | 是 | string | 子频道 ID |
| channel | 是 | Channel | 子频道对象 |
Channel
| 字段名 | 必填 | 类型 | 描述 |
|---|---|---|---|
| name | 否 | string | 子频道名 |
| type | 否 | number | 子频道类型 ChannelType |
| position | 否 | number | 排序 |
| parent_id | 否 | string | 分组 ID |
| private_type | 否 | number | 子频道私密类型 PrivateType |
上述字段需要修改哪个,就传递哪个即可。
ChannelType
| 值 | 描述 |
|---|---|
| 0 | 文字子频道 |
| 1 | 保留,不可用 |
| 2 | 语音子频道 |
| 3 | 保留,不可用 |
| 4 | 子频道分组 |
| 10005 | 直播子频道 |
| 10006 | 应用子频道 |
| 10007 | 论坛子频道 |
注:由于 QQ 频道还在持续的迭代中,经常会有新的子频道类型增加,文档更新不一定及时,开发者识别 ChannelType 时,请注意相关的未知 ID 的处理。
返回说明
返回 ChannelRes 对象。
ChannelRes
| 字段名 | 类型 | 描述 |
|---|---|---|
| id | string | 子频道 ID |
| guild_id | string | 频道 ID |
| name | string | 子频道名 |
| type | number | 子频道类型 ChannelType |
| sub_type | number | 子频道子类型 ChannelSubType |
| position | number | 排序,非必填 |
| parent_id | string | 分组 ID |
| owner_id | string | 创建人 ID |
| private_type | string | 子频道私密类型 PrivateType |
ChannelSubType
| 值 | 描述 |
|---|---|
| 0 | 闲聊 |
| 1 | 公告 |
| 2 | 攻略 |
| 3 | 开黑 |
PrivateType
| 值 | 描述 |
|---|---|
| 0 | 公开频道 |
| 1 | 群主管理员可见 |
| 2 | 群主管理员 + 指定成员 |
返回示例
data:
{"id": "xxxxxx","guild_id": "xxxxxx","name": "子频道","type": 0,"position": 2,"parent_id": "1531395","owner_id": "17734236238436271167","sub_type": 0,"private_type": 0}
