Skip to content

[Guild Member] Adds documentation for GuildMember.flags #5874

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

Merged
hammerdr merged 4 commits into from
Jan 23, 2023
Merged

[Guild Member] Adds documentation for GuildMember.flags #5874

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8326050
[Guild Member] Adds documentation for GuildMember.flags
hammerdr Jan 23, 2023
28c0a5d
update boolean representation
hammerdr Jan 23, 2023
62f29b6
Wording change
hammerdr Jan 23, 2023
62436d5
Apply suggestions from code review
hammerdr Jan 23, 2023
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: 10 additions & 0 deletions docs/resources/Guild.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ A partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object. Represents an Offl
| premium_since? | ?ISO8601 timestamp | when the user started [boosting](https://support.discord.com/hc/en-us/articles/360028038352-Server-Boosting-) the guild |
| deaf | boolean | whether the user is deafened in voice channels |
| mute | boolean | whether the user is muted in voice channels |
| flags | integer | [guild member flags](#DOCS_RESOURCES_GUILD/guild-member-object-guild-member-flags) represented as a bit set, defaults to `0` |
| pending? | boolean | whether the user has not yet passed the guild's [Membership Screening](#DOCS_RESOURCES_GUILD/membership-screening-object) requirements |
| permissions? | string | total permissions of the member in the channel, including overwrites, returned when in the interaction object |
| communication_disabled_until? | ?ISO8601 timestamp | when the user's [timeout](https://support.discord.com/hc/en-us/articles/4413305239191-Time-Out-FAQ) will expire and the user will be able to communicate in the guild again, null or a time in the past if the user is not timed out |
Expand All @@ -371,6 +372,15 @@ A partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object. Represents an Offl
}
```

###### Guild Member Flags

| Flag | Value | Description | Editable |
| ----------------------------------------| ------ | ------------------------------------------------------------- |---------------------|
| DID_REJOIN | 1 << 0 | Member has left and rejoined the guild | false |
| COMPLETED_ONBOARDING | 1 << 1 | Member has completed onboarding | false |
| BYPASSES_VERIFICATION | 1 << 2 | Member bypasses guild verification requirements | true |
| STARTED_ONBOARDING | 1 << 3 | Member has started onboarding | false |

### Integration Object

###### Integration Structure
Expand Down