StickerPack
ClassOn this page
StickerPack is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.
Properties
- Name
bannerId- Type
any- Access
- readonly
- Description
- Instance field
StickerPack.bannerId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
client- Type
any- Access
- readonly
- Description
- Owning Client instance used for REST, cache, and event dispatch.
- Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
coverStickerId- Type
any- Access
- readonly
- Description
- Instance field
StickerPack.coverStickerId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
description- Type
any- Access
- readonly
- Description
- Instance field
StickerPack.description. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
id- Type
any- Access
- readonly
- Description
- Snowflake id of this StickerPack.
- Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
name- Type
any- Access
- readonly
- Description
- Display name of this StickerPack.
- Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
raw- Type
any- Access
- readonly
- Description
- Instance field
StickerPack.raw. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
skuId- Type
any- Access
- readonly
- Description
- Instance field
StickerPack.skuId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Name
stickers- Type
- Collection
- Access
- readonly
- Description
- Instance field
StickerPack.stickers. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this StickerPack.
- Related
- Collection
Methods
StickerPack:bannerURL()
#Performs banner url on this StickerPack. Call it from bot code when you need that operation on the current object.
Signature
StickerPack:bannerURL(options) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
options |
table |
optional | Lua option table. Field names match the corresponding DiscordLua option type when one exists. |
Returns
StickerPack — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a StickerPack
object:bannerURL({})StickerPack:coverSticker()
#Performs cover sticker on this StickerPack. Call it from bot code when you need that operation on the current object.
Signature
StickerPack:coverSticker() Parameters
No parameters.
Returns
StickerPack — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a StickerPack
object:coverSticker()StickerPack:createdAt()
#Create dAt through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.
Signature
StickerPack:createdAt() Parameters
No parameters.
Returns
StickerPack — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a StickerPack
object:createdAt()StickerPack:createdTimestamp()
#Create dTimestamp through REST and cache the result when the request succeeds. Pass function(err, result) to handle failures without raising.
Signature
StickerPack:createdTimestamp() Parameters
No parameters.
Returns
StickerPack — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a StickerPack
object:createdTimestamp()Examples
Obtain this object from a manager, wrap helper, or event payload — it is not constructed directly in typical bot code.
Related APIs
ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationRoleConnectionMetadata · Attachment
Version: discord 1.2.4 · runtime 1.0.0