GuildRole

Extends

DiscordBase.ObjectToLower<Omit<APIRole, "permissions">>

Constructors

new GuildRole(client, data, guildId)

1
new GuildRole(
2
   client: UsingClient,
3
   data: APIRole,
4
   guildId: string): GuildRole

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`APIRole`
`guildId`	`string`

Returns

GuildRole

Inherited from

DiscordBase.constructor

Source

seyfert/src/structures/GuildRole.ts:16

Properties

Property	Modifier	Type	Inherited from
`client`	`readonly`	`UsingClient`	`DiscordBase.client`
`color`	`public`	`number`	`ObjectToLower.color`
`flags`	`public`	`InPrompt`	`ObjectToLower.flags`
`guildId`	`readonly`	`string`	-
`hoist`	`public`	`boolean`	`ObjectToLower.hoist`
`icon`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.icon`
`id`	`public`	`string`	`DiscordBase.id`
`managed`	`public`	`boolean`	`ObjectToLower.managed`
`mentionable`	`public`	`boolean`	`ObjectToLower.mentionable`
`name`	`public`	`string`	`ObjectToLower.name`
`permissions`	`public`	`PermissionsBitField`	-
`position`	`public`	`number`	`ObjectToLower.position`
`tags`	`public`	`undefined` \| `Object`	`ObjectToLower.tags`
`unicodeEmoji`	`public`	`undefined` \| `null` \| `string`	`ObjectToLower.unicodeEmoji`

Accessors

createdAt

1
get createdAt(): Date

createdAt gets the creation Date instace of the current object.

Returns

Date

Source

seyfert/src/structures/extra/DiscordBase.ts:27

createdTimestamp

1
get createdTimestamp(): number

Create a timestamp for the current object.

Returns

number

Source

seyfert/src/structures/extra/DiscordBase.ts:20

Methods

delete()

1
delete(reason?: string): Promise<GuildRole>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<GuildRole>

Source

seyfert/src/structures/GuildRole.ts:34

edit()

1
edit(body: RESTPatchAPIGuildRoleJSONBody, reason?: string): Promise<GuildRole>

Parameters

Parameter	Type
`body`	`RESTPatchAPIGuildRoleJSONBody`
`reason`?	`string`

Returns

Promise<GuildRole>

Source

seyfert/src/structures/GuildRole.ts:30

guild()

1
guild(force: boolean): undefined | Promise<Guild<"cached"> | Guild<"api">>

Parameters

Parameter	Type	Default value
`force`	`boolean`	`false`

Returns

undefined | Promise<Guild<"cached"> | Guild<"api">>

Source

seyfert/src/structures/GuildRole.ts:25

methods()

1
static methods(ctx:     Object): Object

Parameters

Parameter	Type
`ctx`	`Object`
`ctx.client`	`UsingClient`
`ctx.guildId`	`string`

Returns

Object

Member	Type	Value
`create`	(`body`: `RESTPostAPIGuildRoleJSONBody`) => `Promise`<`GuildRole`>	-
`delete`	(`roleId`: `string`, `reason`?: `string`) => `Promise`<`GuildRole`>	-
`edit`	(`roleId`: `string`, `body`: `RESTPatchAPIGuildRoleJSONBody`, `reason`?: `string`) => `Promise`<`GuildRole`>	-
`editPositions`	(`body`: `RESTPatchAPIGuildRolePositionsJSONBody`) => `Promise`<`GuildRole`[]>	-
`list`	(`force`: `boolean`) => `Promise`<`GuildRole`[]>	-

Source

seyfert/src/structures/GuildRole.ts:38