Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISticker

This object represents a sticker.

Hierarchy

  • ISticker

Index

Properties

custom_emoji_id: string

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

emoji?: string

Optional. Emoji associated with the sticker

file_id: string

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

file_size?: number

Optional. File size in bytes

file_unique_id: string

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.

height: number

Sticker height

is_animated: boolean

True, if the sticker is animated

is_video: boolean

True, if the sticker is a video sticker

mask_position?: IMaskPosition

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

needs_repainting: boolean

Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places

premium_animation?: IFile

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

set_name?: string

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

thumbnail?: IPhotoSize

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

type: string

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.

width: number

Sticker width

Generated using TypeDoc