Results

Namespace

Type

Options passed to discord.GuildMember.edit. All properties are optional.

Hierarchy

  • IGuildMemberOptions <-- You are here!

Index

Properties

Optional channelId

channelId: Snowflake | null

If the user is in a voice channel and this property is specified, it moves the member to the specified channel, by id.

Optional communicationDisabledUntil

communicationDisabledUntil: string | null

If specified, the user will be muted (put in "timeout") until the specified date.

The date should be in ISO8601 format. Setting to null will remove the user from timeout.

Optional deaf

deaf: undefined | false | true

If specified, server-wide deafens or un-deafens this member's voice state.

Optional mute

mute: undefined | false | true

If specified, server-wide mutes or un-mutes a user's voice state

Optional nick

nick: undefined | string

If specified, sets the nickname.

Note: Sending an empty string will clear their username.

Optional pending

pending: undefined | false | true

If specified, sets the user's pending status.

Optional roles

roles: Snowflake[]

If specified, replaces the member's roles with the list of role ids provided.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc