Class Role

Represents a role belonging to a guild.

Implements

Role

Index

Constructors

Accessors

_originalIconHash color displayIconURL guild guildId hoist id managed mention mentionable name permissions position tags

Methods

[custom] toJSON toString getIconUrl getMention shouldCache

Constructors

constructor

new Role(
    client: Client,
    data: APIRole | RoleCacheJSON | RoleDiscordJSON | RoleStorageJSON,
    options: { guildId: string; nocache?: boolean },
): Role
Creates the structure for a role.
Parameters
- client: Client
  The client instance.
- data: APIRole | RoleCacheJSON | RoleDiscordJSON | RoleStorageJSON
  The raw role data from Discord.
- options: { guildId: string; nocache?: boolean }
  Additional options for this structure.
  - guildId: string
    The id of the guild that the role belongs to.
  - Optionalnocache?: boolean
    Whether this role should be cached or not.
Returns Role
See
https://discord.com/developers/docs/topics/permissions#role-object-role-structure
- Defined in src/structures/Role.ts:40

Accessors

_originalIconHash

get _originalIconHash(): null | string
The hash of the role's avatar, as it was received from Discord.

Returns null | string
Implementation of RoleType._originalIconHash
- Defined in src/structures/Role.ts:196

color

get color(): number
The color of the role.

Returns number
Implementation of RoleType.color
- Defined in src/structures/Role.ts:267

displayIconURL

get displayIconURL(): null | string
The icon URL of the role.

Returns null | string
Implementation of RoleType.displayIconURL
- Defined in src/structures/Role.ts:227

guild

get guild(): null | Guild
The guild that this role belongs to.

Returns null | Guild
Implementation of RoleType.guild
- Defined in src/structures/Role.ts:237

guildId

get guildId(): string
The ID of the guild that this role belongs to.

Returns string
Implementation of RoleType.guildId
- Defined in src/structures/Role.ts:247

hoist

get hoist(): boolean
Whether the role is hoisted.

Returns boolean
Implementation of RoleType.hoist
- Defined in src/structures/Role.ts:166

id

get id(): string
The ID of the role.

Returns string
Implementation of RoleType.id
- Defined in src/structures/Role.ts:156

managed

get managed(): boolean
Whether the role is managed (by an application).

Returns boolean
Implementation of RoleType.managed
- Defined in src/structures/Role.ts:176

mention

get mention(): string
Returns a mention for the role.

Returns string
Implementation of RoleType.mention
- Defined in src/structures/Role.ts:307

mentionable

get mentionable(): boolean
Whether the role is mentionable.

Returns boolean
Implementation of RoleType.mentionable
- Defined in src/structures/Role.ts:186

name

get name(): string
The name of the role.

Returns string
Implementation of RoleType.name
- Defined in src/structures/Role.ts:257

permissions

get permissions(): string
The permissions for the role.

Returns string
Implementation of RoleType.permissions
- Defined in src/structures/Role.ts:287

position

get position(): number
The position of the role.

Returns number
Implementation of RoleType.position
- Defined in src/structures/Role.ts:277

Methods

[custom]

"[custom]"(): string
Returns string
Method
- Defined in src/structures/Role.ts:384

toJSON

toJSON(
    format?: JsonTypes,
):
    | {
        _attributes: number;
        color: number;
        hoist?: undefined;
        icon: null
        | string;
        id: string;
        managed?: undefined;
        mentionable?: undefined;
        name: string;
        permissions: string;
        position: number;
        tags: undefined | APIRoleTags;
    }
    | {
        _attributes?: undefined;
        color: number;
        hoist: boolean;
        icon: null
        | string;
        id: string;
        managed: boolean;
        mentionable: boolean;
        name: string;
        permissions: string;
        position: number;
        tags: undefined | APIRoleTags;
    }
Returns the JSON representation of this structure.
Parameters
- Optionalformat: JsonTypes
  The format to return the data in.
Returns
    | {
        _attributes: number;
        color: number;
        hoist?: undefined;
        icon: null
        | string;
        id: string;
        managed?: undefined;
        mentionable?: undefined;
        name: string;
        permissions: string;
        position: number;
        tags: undefined | APIRoleTags;
    }
    | {
        _attributes?: undefined;
        color: number;
        hoist: boolean;
        icon: null
        | string;
        id: string;
        managed: boolean;
        mentionable: boolean;
        name: string;
        permissions: string;
        position: number;
        tags: undefined | APIRoleTags;
    }
Method
Implementation of RoleType.toJSON
- Defined in src/structures/Role.ts:395

toString

toString(): string
Returns string
Method
Implementation of RoleType.toString
- Defined in src/structures/Role.ts:376

`Static`getIconUrl

getIconUrl(id: string, hash?: null | string): null | string
Returns the URL of the role's icon.
Parameters
- id: string
  The ID of the role.
- Optionalhash: null | string
  The hash of the role's icon.
Returns null | string
- Defined in src/structures/Role.ts:334

`Static`getMention

getMention(roleId: string, guildId: string): string
Returns a mention for the role.
Parameters
- roleId: string
  The ID of the role to mention.
- guildId: string
  The ID of the guild that the role belongs to.
Returns string
Static
Method
- Defined in src/structures/Role.ts:320

`Static`shouldCache

shouldCache(
gluonCacheOptions: GluonCacheOptions,
guildCacheOptions: GuildCacheOptions,
): boolean
Determines whether the role should be cached.
Parameters
- gluonCacheOptions: GluonCacheOptions
  The cache options for the client.
- guildCacheOptions: GuildCacheOptions
  The cache options for the guild.
Returns boolean
Static
Method
- Defined in src/structures/Role.ts:355

Class Role

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

guildId: string

Optionalnocache?: boolean

Returns Role

See

Accessors

_originalIconHash

Returns null | string

color

Returns number

displayIconURL

Returns null | string

guild

Returns null | Guild

guildId

Returns string

hoist

Returns boolean

id

Returns string

managed

Returns boolean

mention

Returns string

mentionable

Returns boolean

name

Returns string

permissions

Returns string

position

Returns number

tags

Returns undefined | APIRoleTags

Methods

[custom]

Returns string

Method

toJSON

Parameters

Method

toString

Returns string

Method

StaticgetIconUrl

Parameters

Returns null | string

StaticgetMention

Parameters

Returns string

Static

Method

StaticshouldCache

Parameters

Returns boolean

Static

Method

Settings

On This Page

`Optional`nocache?: boolean

`Static`getIconUrl

`Static`getMention

`Static`shouldCache