Preview environment

interface APIGuildMember

export interface APIGuildMember

https://discord.com/developers/docs/resources/guild#guild-member-object

optional
avatar_decoration_data? : APIAvatarDecorationData | null

The data for the member's guild avatar decorationSee https://discord.com/developers/docs/resources/user#avatar-decoration-data-object

optional
avatar? : string | null

The member's guild avatar hash

The member's guild banner hash

optional
communication_disabled_until? : string | null

Timestamp of when the time out will be removed; until then, they cannot interact with the guild

deaf : boolean

Whether the user is deafened in voice channels

flags : GuildMemberFlags

Guild member flags represented as a bit set, defaults to 0

joined_at : string

When the user joined the guild

mute : boolean

Whether the user is muted in voice channels

optional
nick? : string | null

This users guild nickname

optional
pending? : boolean

Whether the user has not yet passed the guild's Membership Screening requirements

optional
premium_since? : string | null

When the user started boosting the guildSee https://support.discord.com/hc/articles/360028038352

roles : Snowflake[]

Array of role object idsSee https://discord.com/developers/docs/topics/permissions#role-object

user : APIUser

The user this guild member represents**This field won't be included in the member object attached to MESSAGE_CREATE and MESSAGE_UPDATE gateway events.**See https://discord.com/developers/docs/resources/user#user-object