Class GuildRole

constructor

• new GuildRole(data, guild, client): GuildRole

• Parameters

  • data: APIRole
  • guild: Guild
  • client: Client

  Returns GuildRole

flags

Optional Readonly guild

guildId

hoist

icon

managed

mentionable

name

permissions

position

tags

_patch

• _patch(): void

• Returns void

delete

• delete(reason?): Promise<boolean>

• Parameters

  • reason: undefined = undefined

  Returns Promise<boolean>

edit

• edit(body, reason?): Promise<null | GuildRole>

• Parameters

  • body: RESTPatchAPIGuildRoleJSONBody & {
        position?: number;
    }
  • Optional reason: string

  Returns Promise<null | GuildRole>

setColor

• setColor(color, reason?): Promise<null | GuildRole>

• Parameters

  • color: number
  • Optional reason: string

  Returns Promise<null | GuildRole>

setEmoji

• setEmoji(unicode_emoji, reason?): Promise<null | GuildRole>

• Parameters

  • unicode_emoji: string
  • Optional reason: string

  Returns Promise<null | GuildRole>

setHoist

• setHoist(hoist, reason?): Promise<null | GuildRole>

• Parameters

  • hoist: boolean
  • Optional reason: string

  Returns Promise<null | GuildRole>

setIcon

• setIcon(icon, reason?): Promise<null | GuildRole>

• Parameters

  • icon: string
  • Optional reason: string

  Returns Promise<null | GuildRole>

setMentionable

• setMentionable(mentionable, reason?): Promise<null | GuildRole>

• Parameters

  • mentionable: boolean
  • Optional reason: string

  Returns Promise<null | GuildRole>

setName

• setName(name, reason?): Promise<null | GuildRole>

• Parameters

  • name: string
  • Optional reason: string

  Returns Promise<null | GuildRole>

setPosition

• setPosition(position, reason?): Promise<null | GuildRole>

• Parameters

  • position: number
  • Optional reason: string

  Returns Promise<null | GuildRole>