Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document posibility of unavailable guilds on Guild Create #5122

Merged
merged 3 commits into from
Sep 14, 2022
Merged

Document posibility of unavailable guilds on Guild Create #5122

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f55f82
Document posibility of unavailable guilds on Guild Create
davfsa Jun 27, 2022
f6c4323
Typo
davfsa Jun 27, 2022
cc5911c
Pull request feedback
davfsa Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/topics/Gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -906,13 +906,15 @@ Sent when a message is pinned or unpinned in a text channel. This is not sent wh

This event can be sent in three different scenarios:

1. When a user is initially connecting, to lazily load and backfill information for all unavailable guilds sent in the [Ready](#DOCS_TOPICS_GATEWAY/ready) event. Guilds that are unavailable due to an outage will send a [Guild Delete](#DOCS_TOPICS_GATEWAY/guild-delete) event.
1. When a user is initially connecting, to lazily load and backfill information for all unavailable guilds sent in the [Ready](#DOCS_TOPICS_GATEWAY/ready) event.
davfsa marked this conversation as resolved.
Show resolved Hide resolved
2. When a Guild becomes available again to the client.
3. When the current user joins a new Guild.
3. When the current user joins a new Guild (this Guild may be available or unavailable).
davfsa marked this conversation as resolved.
Show resolved Hide resolved
davfsa marked this conversation as resolved.
Show resolved Hide resolved

The inner payload is a [guild](#DOCS_RESOURCES_GUILD/guild-object) object, with the following extra fields:
The inner payload can be:
- An available Guild: a [guild](#DOCS_RESOURCES_GUILD/guild-object) object with extra fields, as detailed bellow.
davfsa marked this conversation as resolved.
Show resolved Hide resolved
- An unavailable Guild: an [unavailable guild](#DOCS_RESOURCES_GUILD/unavailable-guild-object) object.

###### Guild Create Extra Fields
###### Guild Create Available Guild Extra Fields
davfsa marked this conversation as resolved.
Show resolved Hide resolved
davfsa marked this conversation as resolved.
Show resolved Hide resolved

| Field | Type | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- |
Expand Down