Skip to content

DiscordGuildRole

The DiscordGuildRole class represents a role in a Discord guild (server) and provides a structure for role data.

Properties

guildId

DiscordGuildRole.guildId  :: string

id

DiscordGuildRole.id  :: string

name

DiscordGuildRole.name  :: string

permissions

DiscordGuildRole.permissions  :: string

position

DiscordGuildRole.position  :: number

color

DiscordGuildRole.color  :: number

hoist

DiscordGuildRole.hoist  :: boolean

managed

DiscordGuildRole.managed  :: boolean

mentionable

DiscordGuildRole.mentionable  :: boolean

type

DiscordGuildRole.type  :: string

The type of the DiscordGuildRole. Default is “DiscordGuildRole”.

Methods

The DiscordGuildRole instance has no set methods!

Functions

updatePositionAsync

DiscordGuildRole . updatePositionAsync (

     position: number
)  -> ()

Creates a new DiscordGuildRole instance.

modifyAsync

DiscordGuildRole . modifyAsync (

     position: Objects.GuildRoleBuilder
)  -> ()

Allows the developer to update/modify a discord role

deleteAsync

DiscordGuildRole . deleteAsync ()  -> ()

Deletes the Role from the discord guild asynchronously.

new

DiscordGuildRole . new (

     discordClient: any
     roleData: table
)  -> ()

Creates a new DiscordGuildRole instance.