Appearance
GuildSticker
Package: @erinjs/core
Represents a custom sticker in a guild.
Constructor
| Name | Type | Optional | Description |
|---|---|---|---|
client | Client | No | |
data | any | No | API sticker from GET /guilds/{id}/stickers or guild sticker events |
guildId | string | No |
Properties
| Name | Type | Readonly | Optional | Description |
|---|---|---|---|---|
animated | boolean | Yes | No | |
client | Client | Yes | No | |
description | string | No | No | |
guildId | string | Yes | No | |
id | string | Yes | No | |
name | string | No | No | |
tags | string[] | Yes | No | |
url | string | Yes | No | CDN URL for this sticker image. |
Methods
delete() async
Delete this sticker. Requires Manage Emojis and Stickers permission.
Returns: Promise<void>
Parameters:
None
edit() async
Edit this sticker's name and/or description. Requires Manage Emojis and Stickers permission.
Returns: Promise<GuildSticker>
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
options | { name?: string; description?: string; } | No |