Skip to content

Commit

Permalink
feat: 添加公告API
Browse files Browse the repository at this point in the history
  • Loading branch information
zoswing authored and ostli committed Jan 8, 2022
1 parent 17ed691 commit 2906d10
Show file tree
Hide file tree
Showing 6 changed files with 168 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/develop/nodesdk/announce/delete_channel_announce.md
@@ -0,0 +1,31 @@
# 删除子频道公告 <Badge text="v2.2.0" />

删除子频道公告。

## 使用示例

```javascript
async function demo() {
let { data } = await client.announceApi.deleteChannelAnnounce(channelId, messageId);
}
```

## 参数说明

| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | ------ | ------------------------------ |
| channelId || string | [子频道 ID](./channel.md) |
| messageId || string | [消息 ID](../model/message.md) |

## 返回说明

成功返回空对象。

## 返回示例

`data`

```js
{
}
```
31 changes: 31 additions & 0 deletions docs/develop/nodesdk/announce/delete_guild_announce.md
@@ -0,0 +1,31 @@
# 删除频道全局公告 <Badge text="v2.2.0" />

删除频道全局公告。

## 使用示例

```javascript
async function demo() {
let { data } = await client.announceApi.deleteGuildAnnounce(guildId, messageId);
}
```

## 参数说明

| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | ------ | ------------------------------ |
| guildId || string | [频道 ID](../model/guild.md) |
| messageId || string | [消息 ID](../model/message.md) |

## 返回说明

成功返回空对象。

## 返回示例

`data`

```js
{
}
```
42 changes: 42 additions & 0 deletions docs/develop/nodesdk/announce/post_channel_announce.md
@@ -0,0 +1,42 @@
# 创建子频道公告 <Badge text="v2.2.0" />

将某条消息创建为子频道的公告。

## 使用示例

```javascript
async function demo() {
let { data } = await client.announceApi.postChannelAnnounce(channelId, messageId);
}
```

## 参数说明

| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | ------ | -------------------------------- |
| channelId || string | [子频道 ID](../model/channel.md) |
| messageId || string | [消息 ID](../model/message.md) |

## 返回说明

返回 [Announce](#announce) 对象。

### Announce

| 字段名 | 类型 | 描述 |
| ------------ | ------ | ------------------------- |
| guild_id | string | [频道 ID](./guild.md) |
| channel_id | string | [子频道 ID](./channel.md) |
| message_time | string | [消息 ID](./message.md) |

## 返回示例

`data`

```json
{
"guild_id": "xxxxxx",
"channel_id": "xxxxxx",
"message_id": "xxxxxx"
}
```
43 changes: 43 additions & 0 deletions docs/develop/nodesdk/announce/post_guild_announce.md
@@ -0,0 +1,43 @@
# 创建频道全局公告 <Badge text="v2.2.0" />

将某个子频道的某条消息创建为频道全局公告。

## 使用示例

```javascript
async function demo() {
let { data } = await client.announceApi.postGuildAnnounce(guildId, channelId, messageId);
}
```

## 参数说明

| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | ------ | -------------------------------- |
| guildId || string | [频道 ID](../model/guild.md) |
| channelId || string | [子频道 ID](../model/channel.md) |
| messageId || string | [消息 ID](../model/message.md) |

## 返回说明

返回 [Announce](#announce) 对象。

### Announce

| 字段名 | 类型 | 描述 |
| ---------- | ------ | ------------------------- |
| guild_id | string | [频道 ID](./guild.md) |
| channel_id | string | [子频道 ID](./channel.md) |
| message_id | string | [消息 ID](./message.md) |

## 返回示例

`data`

```json
{
"guild_id": "xxxxxx",
"channel_id": "xxxxxx",
"message_id": "xxxxxx"
}
```
12 changes: 12 additions & 0 deletions docs/develop/nodesdk/config.js
Expand Up @@ -18,6 +18,7 @@ module.exports = {
{ title: '成员对象(Member)', path: 'model/member' },
{ title: '频道身份组对象(Role)', path: 'model/role' },
{ title: '消息对象(Message)', path: 'model/message' },
{ title: '公告对象(Announce)', path: 'model/announce' },
{ title: '语音对象(Audio)', path: 'model/audio' },
],
},
Expand Down Expand Up @@ -100,6 +101,17 @@ module.exports = {
sidebarDepth: 0,
children: ['mute/mute_all', 'mute/mute_member'],
},
{
title: '公告 API',
collapsable: false,
sidebarDepth: 0,
children: [
'announce/post_guild_announce',
'announce/delete_guild_announce',
'announce/post_channel_announce',
'announce/delete_channel_announce',
],
},
// {
// title: '私信 API',
// collapsable: false,
Expand Down
9 changes: 9 additions & 0 deletions docs/develop/nodesdk/model/announce.md
@@ -0,0 +1,9 @@
# 公告对象(Announce) <Badge text="v2.2.0" />

## Announce

| 字段名 | 类型 | 描述 |
| ------------ | ------ | ------------------------- |
| guild_id | string | [频道 ID](./guild.md) |
| channel_id | string | [子频道 ID](./channel.md) |
| message_id | string | [消息 ID](./message.md) |

0 comments on commit 2906d10

Please sign in to comment.