Skip to content

Commit

Permalink
Adds nsfw_level field to invite example (discord#4334)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jupith
Jupith authored Feb 1, 2022
1 parent c144941 commit 5a0b9f6
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/resources/Invite.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ Represents a code that when used, adds a user to a guild or group DM channel.
###### Invite Structure

| Field | Type | Description |
| --------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| code | string | the invite code (unique ID) |
| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | the guild this invite is for |
| channel | ?partial [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object | the channel this invite is for |
| inviter? | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created the invite |
| target_type? | integer | the [type of target](#DOCS_RESOURCES_INVITE/invite-object-invite-target-types) for this voice channel invite |
| --------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------|
| code | string | the invite code (unique ID) |
| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | the guild this invite is for |
| channel | ?partial [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object | the channel this invite is for |
| inviter? | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created the invite |
| target_type? | integer | the [type of target](#DOCS_RESOURCES_INVITE/invite-object-invite-target-types) for this voice channel invite|
| target_user? | [user](#DOCS_RESOURCES_USER/user-object) object | the user whose stream to display for this voice channel stream invite |
| target_application? | partial [application](#DOCS_RESOURCES_APPLICATION/application-object) object | the embedded application to open for this voice channel embedded application invite |
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| expires_at? | ?ISO8601 timestamp | the expiration date of this invite, returned from the `GET /invites/<code>` endpoint when `with_expiration` is `true` |
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
| expires_at? | ?ISO8601 timestamp | the expiration date of this invite, returned from the `GET /invites/<code>` endpoint when `with_expiration` is `true` |
| stage_instance? | [invite stage instance](#DOCS_RESOURCES_INVITE/invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](#DOCS_RESOURCES_STAGE_INSTANCE) in the Stage channel this invite is for |
| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |
| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id |

###### Invite Target Types

Expand All @@ -42,7 +42,8 @@ Represents a code that when used, adds a user to a guild or group DM channel.
"icon": null,
"features": ["NEWS", "DISCOVERABLE"],
"verification_level": 2,
"vanity_url_code": null
"vanity_url_code": null,
"nsfw_level": 0
},
"channel": {
"id": "165176875973476352",
Expand Down

0 comments on commit 5a0b9f6

Please sign in to comment.