Type alias RolePayload

RolePayload: {
    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

  • Optional botUserId?: string

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

  • Optional colors?: number[]

    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

    The ISO 8601 timestamp that the role was created at

  • Optional icon?: string

    The URL of the role icon

  • id: number

    The ID of the role

  • Optional isBase?: boolean

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

  • Optional isDisplayedSeparately?: boolean

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

  • Optional isMentionable?: boolean

    If set, this role can be mentioned

  • Optional isSelfAssignable?: boolean

    If set, this roll will be self assigned

  • name: string

    The role's name

  • permissions: string[]

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

  • Optional priority?: number

    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

    The ID of the server

  • Optional updatedAt?: string

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

Settings

Member Visibility

Theme

Generated using TypeDoc