Version: Next

GatewayGuildMemberUpdateDispatchData

@see: https://discord.com/developers/docs/topics/gateway-events#guild-member-update

Hierarchy

_Nullable<APIGuildMemberJoined>
APIBaseGuildMember
Partial<APIBaseVoiceGuildMember>
Partial<APIFlaggedGuildMember>
Required<APIGuildMemberUser>
Required<APIGuildMemberAvatar>
- GatewayGuildMemberUpdateDispatchData

Index

Properties

inheritedavatar

avatar: null | string

The member's guild avatar hash

optionalinheritedavatar_decoration_data

avatar_decoration_data?: null | APIAvatarDecorationData

The data for the member's guild avatar decoration

@see: https://discord.com/developers/docs/resources/user#avatar-decoration-data-object

inheritedbanner

banner: null | string

The member's guild banner hash

optionalinheritedcommunication_disabled_until

communication_disabled_until?: null | string

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

optionalinheriteddeaf

deaf?: boolean

Whether the user is deafened in voice channels

optionalinheritedflags

flags?: GuildMemberFlags

Guild member flags represented as a bit set

@defaultValue: 0

guild_id

guild_id: string

The id of the guild

inheritedjoined_at

joined_at: null | string

When the user joined the guild

optionalinheritedmute

mute?: boolean

Whether the user is muted in voice channels

optionalinheritednick

nick?: null | string

This users guild nickname

optionalinheritedpending

pending?: boolean

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

@remarks: If this field is not present, it can be assumed as false.

optionalinheritedpremium_since

premium_since?: null | string

When the user started boosting the guild

@see: https://support.discord.com/hc/articles/360028038352

inheritedroles

roles: string[]

Array of role object ids

@see: https://discord.com/developers/docs/topics/permissions#role-object

inheriteduser

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