Class Role

Guild Role Structure, used in [Guild]

Hierarchy

BaseStructure
- Role

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/role.ts:58
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Role

Properties

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

Readonly 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: bigint = ...

position

position: number = 0

tags

tags: null | { bot_id: string; integration_id?: string; premium_subscriber?: null } = null

Accessors

botId

get botId(): null | string

- Defined in src/structures/role.ts:69
Returns null | string

createdAt

get createdAt(): Date

- Defined in src/structures/role.ts:76
Returns Date

createdAtUnix

get createdAtUnix(): number

- Defined in src/structures/role.ts:80
Returns number

guild

get guild(): null | Guild

- Defined in src/structures/role.ts:84
Returns null | Guild

integrationId

get integrationId(): null | string

- Defined in src/structures/role.ts:88
Returns null | string

isBoosterRole

get isBoosterRole(): boolean

- Defined in src/structures/role.ts:95
Returns boolean

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

isDefault

get isDefault(): boolean

- Defined in src/structures/role.ts:102
Returns boolean

members

get members(): BaseCollection<string, Member>

- Defined in src/structures/role.ts:106
Returns BaseCollection<string, Member>

mention

get mention(): string

- Defined in src/structures/role.ts:124
Returns string

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

can

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

- Defined in src/structures/role.ts:128
Parameters
- permissions: PermissionChecks
- __namedParameters: { ignoreAdministrator?: boolean } = {}
  - Optional ignoreAdministrator?: boolean
Returns boolean

clone

clone(): Role

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Role

delete

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

- Defined in src/structures/role.ts:159
Parameters
- options: DeleteGuildRole = {}
Returns Promise<any>

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

edit

edit(options: EditGuildRole): Promise<Role>

- Defined in src/structures/role.ts:163
Parameters
- options: EditGuildRole
Returns Promise<Role>

editPosition

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

- Defined in src/structures/role.ts:167
Parameters
- position: number
- Optional options: EditGuildRolePositionsExtra
Returns Promise<BaseCollection<string, Role>>

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/role.ts:171
Parameters
- key: string
- value: any
Returns void

permissionsIn

permissionsIn(channelId: string | ChannelGuildBase): bigint

- Defined in src/structures/role.ts:138
Parameters
- channelId: string | ChannelGuildBase
Returns bigint

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

toString

toString(): string

- Defined in src/structures/role.ts:183
Returns string

Generated using TypeDoc