Class Sticker

A sticker

Hierarchy (View Summary)

Constructors

constructor

Properties

attr attr2? dcId? fileSize? location raw type

Accessors

customEmojiFree customEmojiId date emoji fileId fileName hasStickerSet height inputDocument inputMedia inputStickerSet isPremiumSticker isValidSticker maskPosition mimeType sourceType stickerType thumbnails uniqueFileId width

Methods

_fileIdType getThumbnail

Constructors

constructor

Properties

Readonlyattr

attr: RawDocumentAttributeSticker | RawDocumentAttributeCustomEmoji

Optional Readonlyattr2

attr2?: RawDocumentAttributeImageSize | RawDocumentAttributeVideo

Optional ReadonlydcId

dcId?: number

DC ID of the file, when available

Optional ReadonlyfileSize

fileSize?: number

File size in bytes, when available

Readonlylocation

location:
    | Uint8Array
    | TypeInputFileLocation
    | TypeInputWebFileLocation
    | () => Uint8Array | TypeInputFileLocation | TypeInputWebFileLocation

Location of the file.

Either a TL object declaring remote file location, a Buffer containing actual file content (for stripped thumbnails and vector previews), or a function that will return either of those.

When a function is passed, it will be lazily resolved the first time downloading the file.

Readonlyraw

raw: RawDocument

Readonlytype

type: "sticker" = ...

Type of the media (for use in a tagged union)

Accessors

customEmojiFree

  • get customEmojiFree(): boolean

  • Whether this custom emoji can be used by non-premium users. false if this is not a custom emoji.

    Not sure if there are any such stickers currently.

    Returns boolean

customEmojiId

  • get customEmojiId(): Long

  • If this is a custom emoji, its unique ID that can be used in TelegramClient#getCustomEmojis

    Returns Long

date

  • get date(): Date

  • Date the document was sent

    Returns Date

emoji

  • get emoji(): string

  • Primary emoji associated with this sticker, that is displayed in dialogs list.

    If there is none, empty string is returned.

    Note: This only contains at most one emoji. Some stickers have multiple associated emojis, but only one is returned here. This is Telegram's limitation! Use getAllEmojis instead.

    For custom emojis, this alt should be used as a fallback text that will be "behind" the custom emoji entity.

    Returns string

fileId

  • get fileId(): string

  • Get TDLib and Bot API compatible File ID representing this document.

    Returns string

fileName

  • get fileName(): null | string

  • Original file name, extracted from the document attributes.

    Returns null | string

hasStickerSet

  • get hasStickerSet(): boolean

  • Whether this sticker has an associated public sticker set.

    Returns boolean

height

  • get height(): number

  • Sticker height in pixels

    Returns number

inputDocument

  • get inputDocument(): TypeInputDocument

  • Input document TL object generated from this object, to be used with methods that use it

    Returns TypeInputDocument

inputMedia

inputStickerSet

  • get inputStickerSet(): null | TypeInputStickerSet

  • Input sticker set that it associated with this sticker, if available.

    Returns null | TypeInputStickerSet

isPremiumSticker

  • get isPremiumSticker(): boolean

  • Whether this sticker is a premium sticker (has premium fullscreen animation)

    Returns boolean

isValidSticker

  • get isValidSticker(): boolean

  • Whether this sticker is a valid sticker.

    If it is not, then this is probably a WEBP photo that Telegram treats as a sticker.

    Returns boolean

maskPosition

  • get maskPosition(): null | MaskPosition

  • Position where this mask should be placed

    Returns null | MaskPosition

mimeType

  • get mimeType(): string

  • File MIME type, as defined by the sender.

    Returns string

sourceType

stickerType

  • get stickerType(): StickerType

  • Type of the sticker

    Returns StickerType

thumbnails

  • get thumbnails(): readonly Thumbnail[]

  • Available thumbnails, if any.

    If there are no thumbnails, the array will be empty.

    Returns readonly Thumbnail[]

uniqueFileId

  • get uniqueFileId(): string

  • Get a unique File ID representing this document.

    Returns string

width

  • get width(): number

  • Sticker width in pixels

    Returns number

Methods

Protected_fileIdType

getThumbnail

  • getThumbnail(type: string): null | Thumbnail

  • Get a thumbnail by its type.

    Thumbnail types are described in the Telegram docs, and are also available as static members of Thumbnail for convenience.

    Parameters

    • type: string

      Thumbnail type

    Returns null | Thumbnail

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods