Skip to content

Commit

Permalink
style: 解决md文件格式问题
Browse files Browse the repository at this point in the history
  • Loading branch information
ostli authored and zoswing committed Dec 27, 2021
1 parent 0191ffb commit 0ffa175
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 32 deletions.
1 change: 1 addition & 0 deletions .remarkignore
@@ -0,0 +1 @@
/docs/develop/api/*
2 changes: 1 addition & 1 deletion docs/develop/nodesdk/README.md
Expand Up @@ -2,7 +2,7 @@

## 介绍

`NodeSDK`主要基于[基础 API ](../api/README.md)封装,提供给用户一种简单、高效的使用方式。
`NodeSDK`主要基于[基础 API](../api/README.md)封装,提供给用户一种简单、高效的使用方式。

整个 SDK 设计与实现基于**两条主线**

Expand Down
3 changes: 1 addition & 2 deletions docs/develop/pythonsdk/api/audio/post_audio.md
Expand Up @@ -22,7 +22,6 @@ result = audioApi.post_audio(channel_id, audio_control)

字段参见 [AudioControl](#audiocontrol)


# 语音对象

## AudioControl
Expand All @@ -40,4 +39,4 @@ result = audioApi.post_audio(channel_id, audio_control)
| START | 0 | 开始播放操作 |
| PAUSE | 1 | 暂停播放操作 |
| RESUME | 2 | 继续播放操作 |
| STOP | 3 | 停止播放操作 |
| STOP | 3 | 停止播放操作 |
36 changes: 18 additions & 18 deletions docs/develop/pythonsdk/api/channel/create_channel.md
Expand Up @@ -19,8 +19,8 @@ channel_res = api.create_channel(channel_id, channel)
- 要求操作人具有管理频道的权限,如果是机器人,则需要将机器人设置为管理员。
- 创建成功后,返回创建成功的子频道对象,同时会触发一个频道创建的事件通知。
- 目前不支持创建的子频道类型
- 子频道分组
- 私密子频道
- 子频道分组
- 私密子频道

:::

Expand Down Expand Up @@ -71,28 +71,28 @@ channel_res = api.create_channel(channel_id, channel)

### ChannelRes

| 字段名 | 类型 | 描述 |
| --------- | ------ | ---------------------------------------------- |
| id | string | 子频道 ID |
| guild_id | string | 频道 ID |
| name | string | 子频道名 |
| type | number | 子频道类型 [ChannelType](#channeltype) |
| sub_type | number | 子频道子类型 [ChannelSubType](#channelsubtype) |
| position | number | 排序,必填,而且不能够和其他子频道的值重复 |
| owner_id | string | 创建者 ID |
| 字段名 | 类型 | 描述 |
| -------- | ------ | ---------------------------------------------- |
| id | string | 子频道 ID |
| guild_id | string | 频道 ID |
| name | string | 子频道名 |
| type | number | 子频道类型 [ChannelType](#channeltype) |
| sub_type | number | 子频道子类型 [ChannelSubType](#channelsubtype) |
| position | number | 排序,必填,而且不能够和其他子频道的值重复 |
| owner_id | string | 创建者 ID |

## 返回示例

`data`

```json
{
"id": "channel_id",
"guild_id": "guild_id",
"name": "channel_test",
"type": 1,
"position": 1640240055,
"owner_id": "2854198244",
"sub_type": 0
"id": "channel_id",
"guild_id": "guild_id",
"name": "channel_test",
"type": 1,
"position": 1640240055,
"owner_id": "2854198244",
"sub_type": 0
}
```
4 changes: 2 additions & 2 deletions docs/develop/pythonsdk/api/channel/get_channel.md
Expand Up @@ -23,12 +23,12 @@ channel = api.get_channel(channel_id)

字段参见 [Channel](#Channel)


# 子频道对象(Channel)

子频道对象中所涉及的 ID 类数据,都仅在机器人场景流通,与真实的 ID 无关。请不要理解为真实的 ID

### Channel

| 字段名 | 类型 | 描述 |
| --------- | ------ | ---------------------------------------------- |
| id | String | 子频道id |
Expand Down Expand Up @@ -82,4 +82,4 @@ channel = api.get_channel(channel_id)
"owner_id":"0",
"sub_type":0
}
```
```
10 changes: 5 additions & 5 deletions docs/develop/pythonsdk/api/direct_msg/create_direct_message.md
Expand Up @@ -19,16 +19,16 @@ direct_message_guild = api.create_direct_message_guild(request)

## 参数说明

| 字段名 | 类型 | 描述 |
| ----------- | ------ | --------- |
| request | [CreateDirectMessageRequest](#CreateDirectMessageRequest) | 私信频道创建请求 |
| 字段名 | 类型 | 描述 |
| ------- | --------------------------------------------------------- | ---------------- |
| request | [CreateDirectMessageRequest](#CreateDirectMessageRequest) | 私信频道创建请求 |

## CreateDirectMessageRequest

| 字段名 | 类型 | 描述 |
| --------------- | ------ | --------- |
| source_guild_id | string | 源频道 ID |
| user_id | string | 接收者 ID |
| user_id | string | 接收者 ID |

## 返回说明

Expand All @@ -52,4 +52,4 @@ direct_message_guild = api.create_direct_message_guild(request)
"channel_id": "xxxxxx",
"create_time": "1638323931"
}
```
```
Expand Up @@ -13,14 +13,14 @@ api = qqbot.GuildRoleAPI(token, False)
result = api.update_guild_role(guild_id, role_id, role_info)
```

:::warning 注意
:::warning 注意
需要使用的 token 对应的用户具备创建身份组权限。如果是机器人,要求被添加为管理员
:::

## 参数说明

| 字段名 | 必填 | 类型 | 描述 |
| -------- | ---- | --------------------- | -------------- |
| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | --------------------- | -------------- |
| guild_id || string | 频道 ID |
| role_id || string | 身份组 ID |
| role_info || [RoleInfo](#roleinfo) | 频道身份组参数 |
Expand Down Expand Up @@ -68,4 +68,4 @@ result = api.update_guild_role(guild_id, role_id, role_info)
"number": 0,
"member_limit": 2000}
}
```
```

0 comments on commit 0ffa175

Please sign in to comment.