Skip to content

Commit ee625de

Browse files
committed
[clans] Adds documentation for user clan information
1 parent 0a7d731 commit ee625de

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

Diff for: docs/Reference.md

+1
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
344344
| Role Icon | role-icons/[role_id](#DOCS_TOPICS_PERMISSIONS/role-object)/[role_icon](#DOCS_TOPICS_PERMISSIONS/role-object).png | PNG, JPEG, WebP |
345345
| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object)/[scheduled_event_cover_image](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object).png | PNG, JPEG, WebP |
346346
| Guild Member Banner | guilds/[guild_id](#DOCS_RESOURCES_GUILD/guild-object)/users/[user_id](#DOCS_RESOURCES_USER/user-object)/banners/[member_banner](#DOCS_RESOURCES_GUILD/guild-member-object).png \* | PNG, JPEG, WebP, GIF |
347+
| Clan Badge | clan-badges/[guild_id](#DOCS_RESOURCES_GUILD/guild-object)/[badge_hash](#DOCS_RESOURCES_USER/user-object-user-clan).png \* | PNG, JPEG, WebP, GIF |
347348

348349
\* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. (example: `a_1269e74af4df7417b13759eae50c83dc`)
349350

Diff for: docs/resources/User.md

+16
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ There are other rules and restrictions not shared here for the sake of spam and
4343
| premium_type? | integer | the [type of Nitro subscription](#DOCS_RESOURCES_USER/user-object-premium-types) on a user's account | identify |
4444
| public_flags? | integer | the public [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account | identify |
4545
| avatar_decoration? | ?string | the user's [avatar decoration hash](#DOCS_REFERENCE/image-formatting) | identify |
46+
| clan? | ?UserClan | the user's [clan data](#DOCS_RESOURCES_USER/user-object-user-clan) | identify |
4647

4748
###### Example User
4849

@@ -59,6 +60,12 @@ There are other rules and restrictions not shared here for the sake of spam and
5960
"accent_color": 16711680,
6061
"premium_type": 1,
6162
"public_flags": 64
63+
"clan": {
64+
"identity_guild_id": "1234647491267808778",
65+
"identity_enabled": true,
66+
"tag": "DISC",
67+
"badge": "7d1734ae5a615e82bc7a4033b98fade8"
68+
},
6269
}
6370
```
6471

@@ -93,6 +100,15 @@ Premium types denote the level of premium a user has. Visit the [Nitro](https://
93100
| 2 | Nitro |
94101
| 3 | Nitro Basic |
95102

103+
###### User Clan
104+
105+
| Field | Type | Description |
106+
|-------------------|-----------|----------------------------------------------------------|
107+
| identity_guild_id | snowflake | the id of the user's primary clan |
108+
| identity_enabled | boolean | whether the user is displaying their clan tag |
109+
| tag | string | the text of the user's clan tag. Limited to 4 characters |
110+
| badge | string | the [clan badge hash](#DOCS_REFERENCE/image-formatting) |
111+
96112
### Connection Object
97113

98114
The connection object that the user has attached.

0 commit comments

Comments
 (0)