mirror of
https://github.com/danog/MadelineProtoDocs.git
synced 2024-12-02 17:55:35 +01:00
47 lines
2.9 KiB
Markdown
47 lines
2.9 KiB
Markdown
|
---
|
||
|
|
title: "stickerSet"
|
||
|
|
description: "Represents a stickerset (stickerpack)"
|
||
|
|
nav_exclude: true
|
||
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||
|
|
---
|
||
|
|
# Constructor: stickerSet
|
||
|
|
[Back to constructors index](/API_docs/constructors/index.html)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Represents a stickerset (stickerpack)
|
||
|
|
|
||
|
|
### Attributes:
|
||
|
|
|
||
|
|
| Name | Type | Required | Description |
|
||
|
|
|----------|---------------|----------|-------------|
|
||
|
|
|archived|[Bool](/API_docs/types/Bool.html) | Optional|Whether this stickerset was archived (due to too many saved stickers in the current account)|
|
||
|
|
|official|[Bool](/API_docs/types/Bool.html) | Optional|Is this stickerset official|
|
||
|
|
|masks|[Bool](/API_docs/types/Bool.html) | Optional|Is this a mask stickerset|
|
||
|
|
|emojis|[Bool](/API_docs/types/Bool.html) | Optional|This is a custom emoji stickerset|
|
||
|
|
|text\_color|[Bool](/API_docs/types/Bool.html) | 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](/API_docs/types/Bool.html) | Optional|If set, this custom emoji stickerset can be used in [channel emoji statuses](https://core.telegram.org/api/emoji-status).|
|
||
|
|
|creator|[Bool](/API_docs/types/Bool.html) | Optional|
|
||
|
|
|installed\_date|[int](/API_docs/types/int.html) | Optional|When was this stickerset installed|
|
||
|
|
|id|[long](/API_docs/types/long.html) | Yes|ID of the stickerset|
|
||
|
|
|access\_hash|[long](/API_docs/types/long.html) | Yes|Access hash of stickerset|
|
||
|
|
|title|[string](/API_docs/types/string.html) | Yes|Title of stickerset|
|
||
|
|
|short\_name|[string](/API_docs/types/string.html) | Yes|Short name of stickerset, used when sharing stickerset using [stickerset deep links](https://core.telegram.org/api/links#stickerset-links).|
|
||
|
|
|thumbs|Array of [PhotoSize](/API_docs/types/PhotoSize.html) | Optional|Stickerset thumbnail|
|
||
|
|
|thumb\_dc\_id|[int](/API_docs/types/int.html) | Optional|DC ID of thumbnail|
|
||
|
|
|thumb\_version|[int](/API_docs/types/int.html) | Optional|Thumbnail version|
|
||
|
|
|thumb\_document\_id|[long](/API_docs/types/long.html) | Optional|Document ID of custom emoji thumbnail, fetch the document using [messages.getCustomEmojiDocuments](../methods/messages.getCustomEmojiDocuments.html)|
|
||
|
|
|count|[int](/API_docs/types/int.html) | Yes|Number of stickers in pack|
|
||
|
|
|hash|[int](/API_docs/types/int.html) | Yes|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### Type: [StickerSet](/API_docs/types/StickerSet.html)
|
||
|
|
|
||
|
|
|
||
|
|
### 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];
|
||
|
|
```
|