Class InviteRole

constructor

• new InviteRole(data, client, guildID, guild): InviteRole

• Parameters

  • data: RawInviteRole
  • client: Client<ClientEvents>
  • guildID: string
  • guild: InviteGuild

  Returns InviteRole

color

colors

guild

guildID

icon

name

permissions

position

unicodeEmoji

completeGuild

• get completeGuild(): Guild

• The guild this role is in. This will throw an error if the guild is not cached.

  Returns Guild

completeRole

• get completeRole(): undefined | Role

• The complete role this InviteRole represents, if cached.

  Returns undefined | Role

mention

• get mention(): string

• A string that will mention this role.

  Returns string

delete

• delete(reason?): Promise<void>

• Delete this role.

  Parameters

  • Optional reason: string

    The reason for deleting the role.

  Returns Promise<void>

edit

• edit(options): Promise<Role>

• Edit this role.

  Parameters

  • options: EditRoleOptions

    The options for editing the role.

  Returns Promise<Role>

getCompleteRole

• getCompleteRole(): Promise<Role>

• Get the complete role this InviteRole represents.

  Returns Promise<Role>

toJSON

• toJSON(): JSONInviteRole

• Returns JSONInviteRole