Class GuildMember

avatar

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

avatarURL

• avatarURL(options?): null | string

• Parameters

  • Optional options: ImageURLOptions

  Returns null | string

ban

• ban(options?): Promise<GuildMember>

• Parameters

  • Optional options: BanOptions

  Returns Promise<GuildMember>

createDM

• createDM(force?): Promise<DMChannel>

• Parameters

  • Optional force: boolean

  Returns Promise<DMChannel>

deleteDM

• deleteDM(): Promise<DMChannel>

• Returns Promise<DMChannel>

disableCommunicationUntil

• disableCommunicationUntil(timeout, reason?): Promise<GuildMember>

• Parameters

  • timeout: null | DateResolvable

  • Optional reason: string

  Returns Promise<GuildMember>

displayAvatarURL

• displayAvatarURL(options?): string

• Parameters

  • Optional options: ImageURLOptions

  Returns string

edit

• edit(options): Promise<GuildMember>

• Parameters

  • options: GuildMemberEditOptions

  Returns Promise<GuildMember>

fetch

• fetch(force?): Promise<GuildMember>

• Parameters

  • Optional force: boolean

  Returns Promise<GuildMember>

isCommunicationDisabled

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

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

kick

• kick(reason?): Promise<GuildMember>

• Parameters

  • Optional reason: string

  Returns Promise<GuildMember>

permissionsIn

• permissionsIn(channel): Readonly<PermissionsBitField>

• Parameters

  • channel: GuildChannelResolvable

  Returns Readonly<PermissionsBitField>

setFlags

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

• Parameters

  • flags: GuildMemberFlagsResolvable

  • Optional reason: string

  Returns Promise<GuildMember>

setNickname

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

• Parameters

  • nickname: null | string

  • Optional reason: string

  Returns Promise<GuildMember>

timeout

• timeout(timeout, reason?): Promise<GuildMember>

• Parameters

  • timeout: null | number

  • Optional reason: string

  Returns Promise<GuildMember>

toString

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

• Returns `<@${string}>`