Skip to content

Commit b30deee

Browse files
shigmashigma
committed
add translations
1 parent a802920 commit b30deee

File tree

5 files changed

+195
-113
lines changed

5 files changed

+195
-113
lines changed

‎en-US/resources/guild.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ Handle an invitation from a guild.
4848

4949
### guild-added
5050

51-
Triggered when joining a guild. Required resource: `guild`.
51+
Triggered when joining a guild. Required resource: [`guild`](#def-guild).
5252

5353
### guild-updated
5454

55-
Triggered when a guild is modified. Required resource: `guild`.
55+
Triggered when a guild is modified. Required resource: [`guild`](#def-guild).
5656

5757
### guild-removed
5858

59-
Triggered when leaving a guild. Required resource: `guild`.
59+
Triggered when leaving a guild. Required resource: [`guild`](#def-guild).
6060

6161
### guild-request
6262

63-
Triggered when receiving a new guild invitation. Required resource: `guild`.
63+
Triggered when receiving a new guild invitation. Required resource: [`guild`](#def-guild).

‎en-US/resources/login.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@
3737

3838
## API
3939

40-
### Get Login Information {#api-login-get}
40+
### Get Login {#api-login-get}
4141

4242
> <badge>POST</badge> `/login.get` {.route}
4343
44-
Get Login Information. Returns a [`Login`](#def-login) object.
44+
Get the current login. Returns a [`Login`](#def-login) object.
4545

4646
## Events
4747

‎en-US/resources/member.md‎

Lines changed: 71 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,90 @@
1-
# 群组成员 (GuildMember)
1+
# Guild Member
22

3-
## 类型定义
3+
## Definitions
44

5-
```ts
6-
interface GuildMember {
7-
user: User
8-
nick?: string
9-
avatar?: string
10-
}
11-
```
5+
### GuildMember {#def-guild-member}
6+
7+
| FIELD | TYPE | DESCRIPTION |
8+
| --- | --- | --- |
9+
| user | [User](./user.md#user)? | user object |
10+
| nick | string? | user's nickname in the guild |
11+
| avatar | string? | user's avatar in the guild |
12+
| joined_at | number? | join time |
1213

1314
## API
1415

15-
### bot.getGuildMember(guildId, userId)
16+
### Get Guild Member {#api-guild-member-get}
17+
18+
> <badge>POST</badge> `/guild.member.get` {.route}
19+
20+
| FIELD | TYPE | DESCRIPTION |
21+
| --- | --- | --- |
22+
| guild_id | string | guild ID |
23+
| user_id | string | user ID |
24+
25+
Get guild member information. Returns a [GuildMember](#def-guild-member) object.
26+
27+
### Get Guild Member List {#api-guild-member-list}
28+
29+
> <badge>POST</badge> `/guild.member.list` {.route}
30+
31+
| FIELD | TYPE | DESCRIPTION |
32+
| --- | --- | --- |
33+
| guild_id | string | guild ID |
34+
| next | string? | pagination token |
35+
36+
Get all the members in a guild. Returns a [List](../protocol/api.md#list) of [GuildMember](#def-guild-member) objects.
37+
38+
### Kick Guild Member {#api-guild-member-kick}
39+
40+
> <badge>POST</badge> `/guild.member.kick` {.route}
41+
42+
| FIELD | TYPE | DESCRIPTION |
43+
| --- | --- | --- |
44+
| guild_id | string | guild ID |
45+
| user_id | string | user ID |
46+
| permanent | boolean? | whether to permanently ban the user (preventing rejoin) |
47+
48+
Kick a user from the guild.
49+
50+
### Mute Guild Member <badge type="warning">experimental</badge> {#api-guild-member-mute}
51+
52+
> <badge>POST</badge> `/guild.member.mute` {.route}
53+
54+
| FIELD | TYPE | DESCRIPTION |
55+
| --- | --- | --- |
56+
| guild_id | string | guild ID |
57+
| user_id | string | user ID |
58+
| duration | number | mute duration (in milliseconds) |
1659

17-
- **guildId:** `string` 群组 ID
18-
- **userId:** `string` 用户 ID
19-
- 返回值: `Promise<GuildMember>` 群成员信息
60+
Mute a user. If the duration is set to 0, it will unmute the user.
2061

21-
获取群成员信息。
62+
### Approve Guild Member Request {#api-guild-member-approve}
2263

23-
### bot.getGuildMemberList(guildId, next?)
64+
> <badge>POST</badge> `/guild.member.approve` {.route}
2465
25-
- **guildId:** `string` 群组 ID
26-
- **next:** `string` 分页令牌
27-
- 返回值: `Promise<List<GuildMember>>` 群成员列表
66+
| FIELD | TYPE | DESCRIPTION |
67+
| --- | --- | --- |
68+
| message_id | string | request ID |
69+
| approve | boolean | whether to approve the request |
70+
| comment | string? | comment |
2871

29-
获取群成员列表。
72+
Handle a guild join request.
3073

31-
### bot.kickGuildMember(guildId, userId, permanent?)
74+
## Events
3275

33-
- **guildId:** `string` 群组 ID
34-
- **userId:** `string` 用户 ID
35-
- **permanent:** `boolean` 是否永久踢出 (用户无法再次加入群组)
36-
- 返回值: `Promise<void>`
76+
### guild-member-added
3777

38-
将某个用户踢出群组。
78+
Triggered when a guild member is added. Required resources: [`guild`](./guild.md#def-guild), [`member`](#def-guild-member), [`user`](./user.md#def-user).
3979

40-
### bot.muteGuildMember(guildId, userId, duration?, reason?)
80+
### guild-member-updated
4181

42-
- **guildId:** `string` 群组 ID
43-
- **userId:** `string` 用户 ID
44-
- **duration:** `number` 禁言时长 (毫秒)
45-
- **reason:** `string` 禁言说明
46-
- 返回值: `Promise<void>`
82+
Triggered when guild member information is updated. Required resources: [`guild`](./guild.md#def-guild), [`member`](#def-guild-member), [`user`](./user.md#def-user).
4783

48-
将某个用户禁言。如果传入的禁言时长为 `0` 则表示解除禁言。
84+
### guild-member-removed
4985

50-
### bot.handleGuildMemberRequest(messageId, approve, comment?)
86+
Triggered when a guild member is removed. Required resources: [`guild`](./guild.md#def-guild), [`member`](#def-guild-member), [`user`](./user.md#def-user).
5187

52-
- **messageId:** `string` 请求 ID
53-
- **approve:** `boolean` 是否通过请求
54-
- **comment:** `string` 备注信息
55-
- 返回值: `Promise<void>`
88+
### guild-member-request
5689

57-
处理加群请求。
90+
Triggered when a new guild join request is received. Required resources: [`guild`](./guild.md#def-guild), [`member`](#def-guild-member), [`user`](./user.md#def-user).

‎en-US/resources/role.md‎

Lines changed: 73 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,95 @@
1-
# 群组角色 (GuildRole) <badge type="warning">实验性</badge>
1+
# Guild Role <badge type="warning">experimental</badge>
22

3-
## 类型定义
3+
## Definitions
44

5-
```ts
6-
export interface GuildRole {
7-
id: string
8-
name: string
9-
color: number
10-
position: number
11-
}
12-
```
5+
### GuildRole {#def-guild-role}
6+
7+
| FIELD | TYPE | DESCRIPTION |
8+
| --- | --- | --- |
9+
| id | string | role ID |
10+
| name | string? | role name |
1311

1412
## API
1513

16-
### bot.setGuildMemberRole(guildId, userId, roleId)
14+
### Set Guild Member Role {#api-guild-member-role-set}
15+
16+
> <badge>POST</badge> `/guild.member.role.set` {.route}
17+
18+
| FIELD | TYPE | DESCRIPTION |
19+
| --- | --- | --- |
20+
| guild_id | string | guild ID |
21+
| user_id | string | user ID |
22+
| role_id | string | role ID |
23+
24+
Set a role for a user in the guild.
25+
26+
### Unset Guild Member Role {#api-guild-member-role-unset}
27+
28+
> <badge>POST</badge> `/guild.member.role.unset` {.route}
29+
30+
| FIELD | TYPE | DESCRIPTION |
31+
| --- | --- | --- |
32+
| guild_id | string | guild ID |
33+
| user_id | string | user ID |
34+
| role_id | string | role ID |
35+
36+
Remove a role from a user in the guild.
37+
38+
### Get Guild Role List {#api-guild-role-list}
39+
40+
> <badge>POST</badge> `/guild.role.list` {.route}
41+
42+
| FIELD | TYPE | DESCRIPTION |
43+
| --- | --- | --- |
44+
| guild_id | string | guild ID |
45+
| next | string? | pagination token |
46+
47+
Get all roles in a guild. Returns a [List](../protocol/api.md#list) of [GuildRole](#def-guild-role) objects.
48+
49+
### Create Guild Role {#api-guild-role-create}
50+
51+
> <badge>POST</badge> `/guild.role.create` {.route}
1752
18-
- **guildId:** `string` 群组 ID
19-
- **userId:** `string` 用户 ID
20-
- **roleId:** `string` 角色 ID
21-
- 返回值: `Promise<void>`
53+
| FIELD | TYPE | DESCRIPTION |
54+
| --- | --- | --- |
55+
| guild_id | string | guild ID |
56+
| data | [GuildRole](#def-guild-role) | role data |
2257

23-
设置群组内用户的角色。
58+
Create a guild role. Returns a [GuildRole](#def-guild-role) object.
2459

25-
### bot.unsetGuildMemberRole(guildId, userId, roleId)
60+
### Update Guild Role {#api-guild-role-update}
2661

27-
- **guildId:** `string` 群组 ID
28-
- **userId:** `string` 用户 ID
29-
- **roleId:** `string` 角色 ID
30-
- 返回值: `Promise<void>`
62+
> <badge>POST</badge> `/guild.role.update` {.route}
3163
32-
取消群组内用户的角色。
64+
| FIELD | TYPE | DESCRIPTION |
65+
| --- | --- | --- |
66+
| guild_id | string | guild ID |
67+
| role_id | string | role ID |
68+
| data | [GuildRole](#def-guild-role) | role data |
3369

34-
### bot.getGuildRoleList(guildId, next?)
70+
Update a guild role.
3571

36-
- **guildId:** `string` 群组 ID
37-
- **next:** `string` 分页令牌
38-
- 返回值: `Promise<List<GuildRole>>` 角色列表
72+
### Delete Guild Role {#api-guild-role-delete}
3973

40-
获取群组角色列表。
74+
> <badge>POST</badge> `/guild.role.delete` {.route}
4175
42-
### bot.createGuildRole(guildId, data)
76+
| FIELD | TYPE | DESCRIPTION |
77+
| --- | --- | --- |
78+
| guild_id | string | guild ID |
79+
| role_id | string | role ID |
4380

44-
- **guildId:** `string` 群组 ID
45-
- **data:** `Partial<GuildRole>` 角色信息
46-
- 返回值: `Promise<string>` 角色 ID
81+
Delete a guild role.
4782

48-
创建群组角色。
83+
## Events
4984

50-
### bot.modifyGuildRole(guildId, roleId, data)
85+
### guild-role-created
5186

52-
- **guildId:** `string` 群组 ID
53-
- **roleId:** `string` 角色 ID
54-
- **data:** `Partial<GuildRole>` 角色信息
55-
- 返回值: `Promise<void>`
87+
Triggered when a guild role is created. Required resources: [`guild`](./guild.md#def-guild), [`role`](#def-guild-role).
5688

57-
修改群组角色。
89+
### guild-role-updated
5890

59-
### bot.deleteGuildRole(guildId, roleId)
91+
Triggered when a guild role is updated. Required resources: [`guild`](./guild.md#def-guild), [`role`](#def-guild-role).
6092

61-
- **guildId:** `string` 群组 ID
62-
- **roleId:** `string` 角色 ID
63-
- 返回值: `Promise<void>`
93+
### guild-role-deleted
6494

65-
删除群组角色。
95+
Triggered when a guild role is deleted. Required resources: [`guild`](./guild.md#def-guild), [`role`](#def-guild-role).

‎en-US/resources/user.md‎

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,61 @@
1-
# 用户 (User)
1+
# User
22

3-
## 类型定义
3+
## Definitions
44

5-
```ts
6-
export interface User {
7-
id: string
8-
name: string
9-
avatar?: string
10-
}
11-
```
5+
### User {#def-user}
6+
7+
| FIELD | TYPE | DESCRIPTION |
8+
| --- | --- | --- |
9+
| id | string | user ID |
10+
| name | string? | user name<sup>[[1]](#name-nick)</sup> |
11+
| nick | string? | user nickname<sup>[[1]](#name-nick)</sup> |
12+
| avatar | string? | user avatar |
13+
| is_bot | boolean? | whether the user is a bot |
14+
15+
::: tip
16+
**[1] Difference between `name` and `nick`** {#name-nick}
17+
18+
Both fields can be used to identify a user. On some platforms (e.g., Telegram), a user may have multiple types of names, so the SDK can set both fields. On other platforms, these concepts may not be distinct, in which case the SDK only needs to set either `name` or `nick` based on semantics.
19+
20+
In application-level implementations, `nick` takes precedence over `name` because nicknames are easier for users to recognize and understand. If you are developing a client based on the Satori protocol, you should prioritize displaying the `nick` field for usernames and only use the `name` field when `nick` is absent.
21+
:::
1222

1323
## API
1424

15-
### bot.getSelf()
25+
### Get User Information {#api-user-get}
26+
27+
> <badge>POST</badge> `/user.get` {.route}
28+
29+
| FIELD | TYPE | DESCRIPTION |
30+
| --- | --- | --- |
31+
| user_id | string | user ID |
32+
33+
Get a user by ID. Returns a [User](#def-user) object.
1634

17-
- 返回值: `Promise<User>` 用户信息
35+
### Get Friend List {#api-friend-list}
1836

19-
获取机器人自己的信息。
37+
> <badge>POST</badge> `/friend.list` {.route}
2038
21-
### bot.getUser(userId)
39+
| FIELD | TYPE | DESCRIPTION |
40+
| --- | --- | --- |
41+
| next | string? | pagination token |
2242

23-
- **userId:** `string` 用户 ID
24-
- 返回值: `Promise<User>` 用户信息
43+
Get the friend list. Returns a [List](../protocol/api.md#list) of [User](#def-user) objects.
2544

26-
获取用户信息。
45+
### Handle Friend Request {#api-friend-approve}
2746

28-
### bot.getFriendList(next?)
47+
> <badge>POST</badge> `/friend.approve` {.route}
2948
30-
- **next:** `string` 分页令牌
31-
- 返回值: `Promise<List<User>>` 好友列表
49+
| FIELD | TYPE | DESCRIPTION |
50+
| --- | --- | --- |
51+
| message_id | string | request ID |
52+
| approve | boolean | whether to approve the request |
53+
| comment | string? | comment |
3254

33-
获取机器人的好友列表。
55+
Handle a friend request.
3456

35-
### bot.handleFriendRequest(messageId, approve, comment?)
57+
## Events
3658

37-
- **messageId:** `string` 请求 ID
38-
- **approve:** `boolean` 是否通过请求
39-
- **comment:** `string` 备注信息
40-
- 返回值: `Promise<void>`
59+
### friend-request
4160

42-
处理好友请求。
61+
Triggered when a new friend request is received. Required resource: [`user`](#def-user).

0 commit comments

Comments
 (0)