Interface CachedMember

A cached member.

Hierarchy

  • Partial<DiscordTypes.APIGuildMember>
    • CachedMember

Properties

avatar? communication_disabled_until? deaf? flags? guild_id joined_at? mute? nick? pending? premium_since? roles? user? user_id

Properties

Optional avatar

avatar?: null | string

The member's guild avatar hash

Optional communication_disabled_until

communication_disabled_until?: null | string

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

Optional deaf

deaf?: boolean

Whether the user is deafened in voice channels

Optional flags

flags?: GuildMemberFlags

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

guild_id

guild_id: string

The ID of the guild the member object originates from. Always included, regardless of cache control.

Optional joined_at

joined_at?: string

When the user joined the guild

Optional mute

mute?: boolean

Whether the user is muted in voice channels

Optional nick

nick?: null | string

This users guild nickname

Optional pending

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.

Optional premium_since

premium_since?: null | string

When the user started boosting the guild

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

Optional roles

roles?: string[]

Array of role object ids

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

Optional 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

user_id

user_id: string

The ID of the user the member object originates from. Always included, regardless of cache control.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc