Type alias RoleOptions

RoleOptions: {
    color?: number;
    hoist?: boolean;
    icon?: string | null;
    mentionable?: boolean;
    name?: string;
    permissions?: string;
    reason?: string;
    unicode_emoji?: string | null;
}

Type declaration

  • Optional color?: number

    RGB color of the role

  • Optional hoist?: boolean

    If this role should show separately on the member list if it is the highest hoisted role for a member

  • Optional icon?: string | null

    The role's icon

  • Optional mentionable?: boolean

    If the role can be mentioned by users without the ADMINISTRATOR permission

  • Optional name?: string

    Name of the role

  • Optional permissions?: string

    Bitwise value of the permissions

  • Optional reason?: string

    Reason for creating/updating the role

  • Optional unicode_emoji?: string | null

    The role's icon as a unicode emoji

Settings

Member Visibility

Theme

Generated using TypeDoc