Interface GatewayEvent_RoleCreated

interface GatewayEvent_RoleCreated {
    role: {
        botUserId?: string;
        colors?: number[];
        createdAt: string;
        icon?: string;
        id: number;
        isBase: boolean;
        isDisplayedSeparately: boolean;
        isMentionable: boolean;
        isSelfAssignable: boolean;
        name: string;
        permissions: string[];
        priority?: number;
        serverId: string;
        updatedAt?: string;
    };
    serverId: string;
}

Properties

role serverId

Properties

role

role: {
    botUserId?: string;
    colors?: number[];
    createdAt: string;
    icon?: string;
    id: number;
    isBase: boolean;
    isDisplayedSeparately: boolean;
    isMentionable: boolean;
    isSelfAssignable: boolean;
    name: string;
    permissions: string[];
    priority?: number;
    serverId: string;
    updatedAt?: string;
}

Type declaration

  • OptionalbotUserId?: string

    Bot user ID Format: user-id

    Description

    The bot user ID this role has been defined for. Roles with this populated can only be deleted by kicking the bot

  • Optionalcolors?: number[]

    Description

    An array of integer values corresponding to the decimal RGB representation for a color. The first color is solid, and a second color indicates a gradient

  • createdAt: string

    Created at Format: date-time

    Description

    The ISO 8601 timestamp that the role was created at

  • Optionalicon?: string

    Role icon URL Format: media-uri

    Description

    The URL of the role icon

  • id: number

    Role ID

    Description

    The ID of the role

  • isBase: boolean

    Is Base

    Description

    The default role users are given when joining the server. Base roles are tied directly to the server and cannot be created or deleted

    Default

    false
  • isDisplayedSeparately: boolean

    Display Separately

    Description

    If set, the role will be displayed separately in the channel member list

    Default

    false
  • isMentionable: boolean

    Mentionable

    Description

    If set, this role can be mentioned

    Default

    false
  • isSelfAssignable: boolean

    Self Assignable

    Description

    If set, this roll will be self assigned

    Default

    false
  • name: string

    Role name

    Description

    The role's name

  • permissions: string[]

    Description

    Permissions must be a collection of valid permissions as defined in the Enums/Permissions section

  • Optionalpriority?: number

    Priority

    Description

    The priority the role will be in relation to other roles in the server. The higher the value, the more precedence the role has over lower priority roles, and the higher up it will be displayed in the UI. Values can be zero or negative!

  • serverId: string

    Server ID

    Description

    The ID of the server

  • OptionalupdatedAt?: string

    Updated at Format: date-time

    Description

    The ISO 8601 timestamp that the role was updated at, if relevant

serverId

serverId: string

The ID of the server

Settings

Member Visibility

On This Page

Properties