Class Role

color

flags

guild

hoist

icon

id

managed

mentionable

name

permissions

rawPosition

tags

unicodeEmoji

createdAt

• get createdAt(): Date

• Returns Date

createdTimestamp

• get createdTimestamp(): number

• Returns number

editable

• get editable(): boolean

• Returns boolean

hexColor

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

• Returns `#${string}`

members

• get members(): Collection<string, GuildMember>

• Returns Collection<string, GuildMember>

position

• get position(): number

• Returns number

comparePositionTo

• comparePositionTo(role): number

• Parameters

  • role: RoleResolvable

  Returns number

delete

• delete(reason?): Promise<Role>

• Parameters

  • Optional reason: string

  Returns Promise<Role>

edit

• edit(options): Promise<Role>

• Parameters

  • options: RoleEditOptions

  Returns Promise<Role>

equals

• equals(role): boolean

• Parameters

  • role: Role

  Returns boolean

iconURL

• iconURL(options?): null | string

• Parameters

  • Optional options: ImageURLOptions

  Returns null | string

permissionsIn

• permissionsIn(channel, checkAdmin?): Readonly<PermissionsBitField>

• Parameters

  • channel: string | NonThreadGuildBasedChannel

  • Optional checkAdmin: boolean

  Returns Readonly<PermissionsBitField>

setColor

• setColor(color, reason?): Promise<Role>

• Parameters

  • color: ColorResolvable

  • Optional reason: string

  Returns Promise<Role>

setHoist

• setHoist(hoist?, reason?): Promise<Role>

• Parameters

  • Optional hoist: boolean

  • Optional reason: string

  Returns Promise<Role>

setIcon

• setIcon(icon, reason?): Promise<Role>

• Parameters

  • icon: null | string | GuildEmoji | Buffer | ReactionEmoji

  • Optional reason: string

  Returns Promise<Role>

setMentionable

• setMentionable(mentionable?, reason?): Promise<Role>

• Parameters

  • Optional mentionable: boolean

  • Optional reason: string

  Returns Promise<Role>

setName

• setName(name, reason?): Promise<Role>

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<Role>

setPermissions

• setPermissions(permissions, reason?): Promise<Role>

• Parameters

  • permissions: PermissionResolvable

  • Optional reason: string

  Returns Promise<Role>

setPosition

• setPosition(position, options?): Promise<Role>

• Parameters

  • position: number

  • Optional options: SetRolePositionOptions

  Returns Promise<Role>

setUnicodeEmoji

• setUnicodeEmoji(unicodeEmoji, reason?): Promise<Role>

• Parameters

  • unicodeEmoji: null | string

  • Optional reason: string

  Returns Promise<Role>

toJSON

• toJSON(): unknown

• Returns unknown

toString

• toString(): RoleMention

• Returns RoleMention