Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Role

Guild Role Structure, used in [Guild]

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_keys

_keys: BaseSet<string> = keysRole

_keysMerge

_keysMerge: BaseSet<string> = keysMergeRole

client

client: ShardClient

color

color: number = 0

guildId

guildId: string = ""

hoist

hoist: boolean = false

id

id: string = ""

managed

managed: boolean = false

mentionable

mentionable: boolean = false

name

name: string = ""

permissions

permissions: number = 0

position

position: number = 0

tags

tags: object | null = null

Accessors

botId

  • get botId(): null | string

  • Returns null | string

createdAt

  • get createdAt(): Date

  • Returns Date

createdAtUnix

  • get createdAtUnix(): number

  • Returns number

guild

  • get guild(): Guild | null

  • Returns Guild | null

integrationId

  • get integrationId(): null | string

  • Returns null | string

isBoosterRole

  • get isBoosterRole(): boolean

  • Returns boolean

isDefault

  • get isDefault(): boolean

  • Returns boolean

members

  • get members(): BaseCollection<string, Member>

  • Returns BaseCollection<string, Member>

mention

  • get mention(): string

  • Returns string

shardId

  • get shardId(): number

  • Returns number

Methods

[inspect.custom]

  • [inspect.custom](): object

_getFromSnake

  • _getFromSnake(key: string): any

  • Parameters

    • key: string

    Returns any

_setFromSnake

  • _setFromSnake(key: string, value: any): any

  • Parameters

    • key: string
    • value: any

    Returns any

can

  • can(permissions: PermissionTools.PermissionChecks, __namedParameters?: object): boolean

  • Parameters

    • permissions: PermissionTools.PermissionChecks
    • Default value __namedParameters: object = {}
      • ignoreAdministrator: undefined | false | true

    Returns boolean

delete

  • delete(options?: DeleteGuildRole): Promise<any>

  • Parameters

    • Default value options: DeleteGuildRole = {}

    Returns Promise<any>

difference

  • difference(key: string, value: any): [boolean, any]

  • Parameters

    • key: string
    • value: any

    Returns [boolean, any]

differences

edit

  • edit(options: EditGuildRole): Promise<Role>

  • Parameters

    • options: EditGuildRole

    Returns Promise<Role>

merge

mergeValue

  • mergeValue(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

permissionsIn

  • Parameters

    Returns number

toJSON

  • toJSON(): object

  • Returns object

toString

  • toString(): string

  • Returns string

Generated using TypeDoc