class Sticker

This object represents a sticker.

Methods

__construct(string $file_id, string $file_unique_id, string $type, int $width, int $height, bool $is_animated, bool $is_video, PhotoSize|null $thumb = null, string|null $emoji = null, string|null $set_name = null, File|null $premium_animation = null, MaskPosition|null $mask_position = null, string|null $custom_emoji_id = null, int|null $file_size = null)

No description

string
getFileId()

Identifier for this file, which can be used to download or reuse the file.

string
getFileUniqueId()

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

string
getType()

Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

int
getWidth()

Sticker width.

int
getHeight()

Sticker height.

bool
getIsAnimated()

True, if the sticker is animated.

bool
getIsVideo()

True, if the sticker is a video sticker.

PhotoSize|null
getThumb()

Optional. Sticker thumbnail in the .WEBP or .JPG format.

string|null
getEmoji()

Optional. Emoji associated with the sticker.

string|null
getSetName()

Optional. Name of the sticker set to which the sticker belongs.

File|null
getPremiumAnimation()

Optional. For premium regular stickers, premium animation for the sticker.

MaskPosition|null
getMaskPosition()

Optional. For mask stickers, the position where the mask should be placed.

string|null
getCustomEmojiId()

Optional. For custom emoji stickers, unique identifier of the custom emoji.

int|null
getFileSize()

Optional. File size in bytes.

Details

at line 26
__construct(string $file_id, string $file_unique_id, string $type, int $width, int $height, bool $is_animated, bool $is_video, PhotoSize|null $thumb = null, string|null $emoji = null, string|null $set_name = null, File|null $premium_animation = null, MaskPosition|null $mask_position = null, string|null $custom_emoji_id = null, int|null $file_size = null)

No description

Parameters

string $file_id
string $file_unique_id
string $type
int $width
int $height
bool $is_animated
bool $is_video
PhotoSize|null $thumb
string|null $emoji
string|null $set_name
File|null $premium_animation
MaskPosition|null $mask_position
string|null $custom_emoji_id
int|null $file_size

at line 47
string getFileId()

Identifier for this file, which can be used to download or reuse the file.

Return Value

string

at line 55
string getFileUniqueId()

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Return Value

string

at line 63
string getType()

Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.

Return Value

string

at line 71
int getWidth()

Sticker width.

Return Value

int

at line 79
int getHeight()

Sticker height.

Return Value

int

at line 87
bool getIsAnimated()

True, if the sticker is animated.

Return Value

bool

at line 95
bool getIsVideo()

True, if the sticker is a video sticker.

Return Value

bool

at line 103
PhotoSize|null getThumb()

Optional. Sticker thumbnail in the .WEBP or .JPG format.

Return Value

PhotoSize|null

at line 111
string|null getEmoji()

Optional. Emoji associated with the sticker.

Return Value

string|null

at line 119
string|null getSetName()

Optional. Name of the sticker set to which the sticker belongs.

Return Value

string|null

at line 127
File|null getPremiumAnimation()

Optional. For premium regular stickers, premium animation for the sticker.

Return Value

File|null

at line 135
MaskPosition|null getMaskPosition()

Optional. For mask stickers, the position where the mask should be placed.

Return Value

MaskPosition|null

at line 143
string|null getCustomEmojiId()

Optional. For custom emoji stickers, unique identifier of the custom emoji.

Return Value

string|null

at line 151
int|null getFileSize()

Optional. File size in bytes.

Return Value

int|null