Skip to main content
Version: 0.37.112

GatewayGuildMemberAddDispatchData

https://discord.com/developers/docs/topics/gateway-events#guild-member-add

Hierarchy

Index

Properties

Properties

optionalavatar

avatar?: null | string

The member’s guild avatar hash

optionalavatar_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

optionalbanner

banner?: null | string

The member’s guild banner hash

optionalcommunication_disabled_until

communication_disabled_until?: null | string

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

deaf

deaf: boolean

Whether the user is deafened in voice channels

flags

flags: GuildMemberFlags

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

guild_id

guild_id: string

The id of the guild

joined_at

joined_at: string

When the user joined the guild

mute

mute: boolean

Whether the user is muted in voice channels

optionalnick

nick?: null | string

This users guild nickname

optionalpending

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.

optionalpremium_since

premium_since?: null | string

When the user started boosting the guild

See https://support.discord.com/hc/articles/360028038352

roles

roles: string[]

Array of role object ids

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

user

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