Skip to content

Commit fc88373

Browse files
advaith1advaith1
authored
Update invite docs (#7779)
* Update invite docs * remove from stage instance file
1 parent b1baf1c commit fc88373

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

‎docs/events/gateway-events.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,7 @@ Sent when a new invite to a channel is created.
977977
| target_application? | partial [application](/docs/resources/application#application-object) object | Embedded application to open for this voice channel embedded application invite |
978978
| temporary | boolean | Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role) |
979979
| uses | integer | How many times the invite has been used (always will be 0) |
980+
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |
980981

981982
#### Invite Delete
982983

‎docs/resources/invite.mdx‎

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,21 @@ Represents a code that when used, adds a user to a guild or group DM channel.
1010

1111
###### Invite Structure
1212

13-
| Field | Type | Description |
14-
|-----------------------------|----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
15-
| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) |
16-
| code | string | the invite code (unique ID) |
17-
| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for |
18-
| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for |
19-
| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite |
20-
| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite |
21-
| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite |
22-
| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite |
23-
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
24-
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
25-
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |
26-
| 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 (deprecated) |
27-
| 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 |
28-
| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites |
13+
| Field | Type | Description |
14+
|-----------------------------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
15+
| type | integer | the [type of invite](/docs/resources/invite#invite-object-invite-types) |
16+
| code | string | the invite code (unique ID) |
17+
| guild? | partial [guild](/docs/resources/guild#guild-object) object | the guild this invite is for |
18+
| channel | ?partial [channel](/docs/resources/channel#channel-object) object | the channel this invite is for |
19+
| inviter? | [user](/docs/resources/user#user-object) object | the user who created the invite |
20+
| target_type? | integer | the [type of target](/docs/resources/invite#invite-object-invite-target-types) for this voice channel invite |
21+
| target_user? | [user](/docs/resources/user#user-object) object | the user whose stream to display for this voice channel stream invite |
22+
| target_application? | partial [application](/docs/resources/application#application-object) object | the embedded application to open for this voice channel embedded application invite |
23+
| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
24+
| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/<code>` endpoint when `with_counts` is `true` |
25+
| expires_at | ?ISO8601 timestamp | the expiration date of this invite |
26+
| 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 |
27+
| flags? | integer | [guild invite flags](/docs/resources/invite#invite-object-guild-invite-flags) for guild invites |
2928

3029
###### Invite Types
3130

‎docs/resources/stage-instance.mdx‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ Below are some definitions related to stages.
5555
- **Topic**: This is the blurb that gets shown below the channel's name, among other places.
5656
- **Public**: A Stage instance is public when it has a `privacy_level` of `PUBLIC`. While a guild has a public Stage instance:
5757
- Users in the Stage can have the Stage show in their [activities](/docs/events/gateway-events#presence).
58-
- [Invites](/docs/resources/invite#invite-object) to the Stage channel will have the `stage_instance` field.
5958

6059
## Auto Closing
6160

0 commit comments

Comments
 (0)