Class GuildMember

avatar

avatarDecorationData

banner

Readonlyclient

communicationDisabledUntilTimestamp

flags

guild

joinedTimestamp

nickname

pending

premiumSinceTimestamp

user

bannable

• get bannable(): boolean

  Returns boolean

communicationDisabledUntil

• get communicationDisabledUntil(): null | Date

  Returns null | Date

displayColor

• get displayColor(): number

  Returns number

displayHexColor

• get displayHexColor(): `#${string}`

  Returns `#${string}`

displayName

• get displayName(): string

  Returns string

dmChannel

• get dmChannel(): null | DMChannel

  Returns null | DMChannel

id

• get id(): string

  Returns string

joinedAt

• get joinedAt(): null | Date

  Returns null | Date

kickable

• get kickable(): boolean

  Returns boolean

manageable

• get manageable(): boolean

  Returns boolean

moderatable

• get moderatable(): boolean

  Returns boolean

partial

• get partial(): false

  Returns false

permissions

• get permissions(): Readonly<PermissionsBitField>

  Returns Readonly<PermissionsBitField>

premiumSince

• get premiumSince(): null | Date

  Returns null | Date

presence

• get presence(): null | Presence

  Returns null | Presence

roles

• get roles(): GuildMemberRoleManager

  Returns GuildMemberRoleManager

voice

• get voice(): VoiceState

  Returns VoiceState

avatarDecorationURL

• avatarDecorationURL(): null | string

  Returns null | string

avatarURL

• avatarURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

ban

• ban(options?: BanOptions): Promise<GuildMember>

  Parameters

  • Optionaloptions: BanOptions

  Returns Promise<GuildMember>

bannerURL

• bannerURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

createDM

• createDM(force?: boolean): Promise<DMChannel>

  Parameters

  • Optionalforce: boolean

  Returns Promise<DMChannel>

deleteDM

• deleteDM(): Promise<DMChannel>

  Returns Promise<DMChannel>

disableCommunicationUntil

• disableCommunicationUntil(
      timeout: null | DateResolvable,
      reason?: string,
  ): Promise<GuildMember>

  Parameters

  • timeout: null | DateResolvable
  • Optionalreason: string

  Returns Promise<GuildMember>

displayAvatarDecorationURL

• displayAvatarDecorationURL(): null | string

  Returns null | string

displayAvatarURL

• displayAvatarURL(options?: ImageURLOptions): string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns string

displayBannerURL

• displayBannerURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

edit

• edit(options: GuildMemberEditOptions): Promise<GuildMember>

  Parameters

  • options: GuildMemberEditOptions

  Returns Promise<GuildMember>

fetch

• fetch(force?: boolean): Promise<GuildMember>

  Parameters

  • Optionalforce: boolean

  Returns Promise<GuildMember>

isCommunicationDisabled

• isCommunicationDisabled(): this is GuildMember & {
      communicationDisabledUntil: Date;
      communicationDisabledUntilTimestamp: number;
  }

  Returns this is GuildMember & {
      communicationDisabledUntil: Date;
      communicationDisabledUntilTimestamp: number;
  }

kick

• kick(reason?: string): Promise<GuildMember>

  Parameters

  • Optionalreason: string

  Returns Promise<GuildMember>

permissionsIn

• permissionsIn(channel: GuildChannelResolvable): Readonly<PermissionsBitField>

  Parameters

  • channel: GuildChannelResolvable

  Returns Readonly<PermissionsBitField>

setFlags

• setFlags(
      flags: GuildMemberFlagsResolvable,
      reason?: string,
  ): Promise<GuildMember>

  Parameters

  • flags: GuildMemberFlagsResolvable
  • Optionalreason: string

  Returns Promise<GuildMember>

setNickname

• setNickname(nickname: null | string, reason?: string): Promise<GuildMember>

  Parameters

  • nickname: null | string
  • Optionalreason: string

  Returns Promise<GuildMember>

timeout

• timeout(timeout: null | number, reason?: string): Promise<GuildMember>

  Parameters

  • timeout: null | number
  • Optionalreason: string

  Returns Promise<GuildMember>

toJSON

• toJSON(): unknown

  Returns unknown

toString

• toString(): `<@${string}>`

  Returns a string representation of an object.

  Returns `<@${string}>`

valueOf

• valueOf(): string

  Returns string