Documentation/detritus-client/Structures

Roleclass

Guild Role Structure, used in [Guild]

On this page

Overview
Constructor1
Properties15
Accessors15
Methods21

Guild Role Structure, used in [Guild]

import { Structures } from 'detritus-client';

Structures.Role;

Hierarchy

StructureBaseStructureRole

27 properties11 methods13 inheritedsrc/structures/role.ts:66

Constructor

new Role

src/structures/role.ts:85

new Role(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

client

ShardClient

readonly

Inherited from BaseStructure.client

color

number

Default 0

colors

RoleColors | null

Default null

flags

number

Default 0

guildId

string

Default ''

hoist

boolean

Default false

icon

string | null

Default null

string

Default ''

managed

boolean

Default false

mentionable

boolean

Default false

name

string

Default ''

permissions

bigint

Default Permissions.NONE

position

number

Default 0

Accessors

botId

string | null

get

createdAt

Date

get

createdAtUnix

number

get

guild

Guild | null

get

iconUrl

string | null

get

integrationId

string | null

get

isBoosterRole

boolean

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isDefault

boolean

get

isInPrompt

boolean

get

isPurchasable

boolean

get

members

BaseCollection<string, Member>

get

mention

string

get

shardId

number

get

Inherited from BaseStructure.shardId

subscriptionListingId

string | null

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

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

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

can()

src/structures/role.ts:175

can(
  permissions: PermissionChecks,
  __namedParameters?: { ignoreAdministrator?: boolean },
): boolean

Parameters

permissions

PermissionChecks

__namedParameters?

{ ignoreAdministrator?: boolean }

__namedParameters.ignoreAdministrator?

boolean

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

delete()

async src/structures/role.ts:241

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

difference()

src/structures/basestructure.ts:146

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

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

edit()

async src/structures/role.ts:245

edit(options: EditGuildRole): Promise<Role>

editPosition()

async src/structures/role.ts:249

editPosition(
  position: number,
  options?: EditGuildRolePositionsExtra,
): Promise<BaseCollection<string, Role>>

hasDifference()

src/structures/role.ts:253

hasDifference(key: string, value: any): boolean

Overrides BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

hasFlag()

src/structures/role.ts:185

hasFlag(flag: number): boolean

iconUrlFormat()

src/structures/role.ts:189

iconUrlFormat(
  format?: string | number | UrlQuery | null,
  query?: number | UrlQuery,
): string | null

merge()

src/structures/role.ts:274

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

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

Inherited from BaseStructure.mergeValue

permissionsIn()

src/structures/role.ts:203

permissionsIn(
  channelId: string | ChannelGuildBase,
  __namedParameters?: { ignoreAdministrator?: boolean },
): bigint

Parameters

channelId

string | ChannelGuildBase

__namedParameters?

{ ignoreAdministrator?: boolean }

__namedParameters.ignoreAdministrator?

boolean

toJSON()

src/structures/role.ts:333

toJSON(): any

Overrides BaseStructure.toJSON

toString()

src/structures/role.ts:346

toString(): string

Returns a string representation of an object.