Interface APIRole

See

https://discord.com/developers/docs/topics/permissions#role-object

interface APIRole {
    color: number;
    colors?: APIRoleColors;
    flags: InPrompt;
    hoist: boolean;
    icon?: null | string;
    id: string;
    managed: boolean;
    mentionable: boolean;
    name: string;
    permissions: string;
    position: number;
    tags?: APIRoleTags;
    unicode_emoji?: null | string;
}

Properties

color colors? flags hoist icon? id managed mentionable name permissions position tags? unicode_emoji?

Properties

color

color: number

Integer representation of hexadecimal color code

Remarks

color will still be returned by the API, but using the colors field is recommended when doing requests.

Optionalcolors

colors?: APIRoleColors

The role's colors

flags

flags: InPrompt

Role flags

hoist

hoist: boolean

If this role is pinned in the user listing

Optionalicon

icon?: null | string

The role icon hash

id

id: string

Role id

managed

managed: boolean

Whether this role is managed by an integration

mentionable

mentionable: boolean

Whether this role is mentionable

name

name: string

Role name

permissions

permissions: string

Permission bit set

See

https://en.wikipedia.org/wiki/Bit_field

position

position: number

Position of this role

Optionaltags

tags?: APIRoleTags

The tags this role has

Optionalunicode_emoji

unicode_emoji?: null | string

The role unicode emoji as a standard emoji

Settings

Member Visibility

On This Page

Properties