Role | /src/structures/role.ts | harmony@v2.6.0

Module

x/harmony/src/structures/role.ts>Role

An easy to use Discord API Library for Deno.

harmonyland/harmony

Popular

Go to Latest

application.ts

Application

ApplicationFlagsManager

applicationCommand.ts

ApplicationCommandInteraction

SlashCommandInteraction

InteractionApplicationCommandResolved

autocompleteInteraction.ts

AutocompleteInteraction

ModifyGuildEmojiParams

guildCategoryChannel.ts

CategoryChannel

guildNewsChannel.ts

NewsChannel

guildStageVoiceChannel.ts

GuildTextBasedChannel

GuildTextChannel

CreateThreadOptions

checkGuildTextBasedChannel

guildVoiceChannel.ts

VoiceChannel

guildVoiceStageChannel.ts

BaseInteractionResponse

InteractionMessageOptions

InteractionResponseAutocompleteChoices

InteractionResponseModal

MessageComponentInteraction

modalSubmitInteraction.ts

ModalSubmitInteraction

ModalSubmitComponentActionRow

ModalSubmitComponentTextInput

ModalSubmitComponentBase

ModifyGuildTemplateParams

WebhookMessageOptions

AllWebhookMessageOptions

class Role

extends SnowflakeBase

import { Role } from "https://deno.land/x/harmony@v2.6.0/src/structures/role.ts";

Represents a Guild Role

Constructors

new

Role(

client: Client,

data: RolePayload,

guild: Guild,

)

Properties

color: number

guild: Guild

hoist: boolean

optional

icon: string

id: string

managed: boolean

mentionable: boolean

name: string

permissions: Permissions

position: number

optional

tags: RoleTags

optional

unicodeEmoji: string

Methods

addTo(member: Member | User | string): Promise<boolean>

Add the Role to a Member

delete(): Promise<Role | undefined>

Delete the Role

edit(options: RoleModifyPayload): Promise<Role>

Edit the Role

readFromData(data: RolePayload): void

removeFrom(member: Member | User | string): Promise<boolean>

Remove the Role from a Member

roleIcon(format?: ImageFormats, size?: ImageSize): string | undefined

Get the icon for the role. If set, is either a URL to an icon, or a Unicode emoji.