MadelineProtoDocs/docs/API_docs/constructors/stickerSet.md
2024-05-01 14:53:46 +02:00

2.9 KiB

title description nav_exclude image
stickerSet Represents a stickerset (stickerpack) true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: stickerSet

Back to constructors index

Represents a stickerset (stickerpack)

Attributes:

Name Type Required Description
archived Bool Optional Whether this stickerset was archived (due to too many saved stickers in the current account)
official Bool Optional Is this stickerset official
masks Bool Optional Is this a mask stickerset
emojis Bool Optional This is a custom emoji stickerset
text_color Bool Optional Whether the color of this TGS custom emoji stickerset should be changed to the text color when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context.
channel_emoji_status Bool Optional If set, this custom emoji stickerset can be used in channel emoji statuses.
creator Bool Optional
installed_date int Optional When was this stickerset installed
id long Yes ID of the stickerset
access_hash long Yes Access hash of stickerset
title string Yes Title of stickerset
short_name string Yes Short name of stickerset, used when sharing stickerset using stickerset deep links.
thumbs Array of PhotoSize Optional Stickerset thumbnail
thumb_dc_id int Optional DC ID of thumbnail
thumb_version int Optional Thumbnail version
thumb_document_id long Optional Document ID of custom emoji thumbnail, fetch the document using messages.getCustomEmojiDocuments
count int Yes Number of stickers in pack
hash int Yes

Type: StickerSet

Example:

$stickerSet = ['_' => 'stickerSet', 'archived' => Bool, 'official' => Bool, 'masks' => Bool, 'emojis' => Bool, 'text_color' => Bool, 'channel_emoji_status' => Bool, 'creator' => Bool, 'installed_date' => int, 'id' => long, 'access_hash' => long, 'title' => 'string', 'short_name' => 'string', 'thumbs' => [PhotoSize, PhotoSize], 'thumb_dc_id' => int, 'thumb_version' => int, 'thumb_document_id' => long, 'count' => int, 'hash' => int];