Class Thumbnail

One size of some thumbnail

Hierarchy (View Summary)

Constructors

constructor

Properties

dcId? fileSize? height location raw width THUMB_100x100_BOX THUMB_1280x1280_BOX THUMB_1280x1280_CROP THUMB_160x160_CROP THUMB_2560x2560_BOX THUMB_320x320_BOX THUMB_320x320_CROP THUMB_640x640_CROP THUMB_800x800_BOX THUMB_EMOJI_MARKUP THUMB_OUTLINE THUMB_STICKER_MARKUP THUMB_STRIP THUMB_VIDEO_FULLSCREEN THUMB_VIDEO_PREVIEW THUMB_VIDEO_PROFILE

Accessors

fileId isVideo path type uniqueFileId

Constructors

constructor

Properties

Optional ReadonlydcId

dcId?: number

DC ID of the file, when available

Optional ReadonlyfileSize

fileSize?: number

File size in bytes, when available

Readonlyheight

height: number

Thumbnail height (NaN for THUMB_OUTLINE and THUMB_STRIP)

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: TypePhotoSize | TypeVideoSize

Readonlywidth

width: number

Thumbnail width (NaN for THUMB_OUTLINE and THUMB_STRIP)

Static ReadonlyTHUMB_100x100_BOX

THUMB_100x100_BOX: "s" = 's'

Static ReadonlyTHUMB_1280x1280_BOX

THUMB_1280x1280_BOX: "y" = 'y'

Static ReadonlyTHUMB_1280x1280_CROP

THUMB_1280x1280_CROP: "d" = 'd'

Static ReadonlyTHUMB_160x160_CROP

THUMB_160x160_CROP: "a" = 'a'

Static ReadonlyTHUMB_2560x2560_BOX

THUMB_2560x2560_BOX: "w" = 'w'

Static ReadonlyTHUMB_320x320_BOX

THUMB_320x320_BOX: "m" = 'm'

Static ReadonlyTHUMB_320x320_CROP

THUMB_320x320_CROP: "b" = 'b'

Static ReadonlyTHUMB_640x640_CROP

THUMB_640x640_CROP: "c" = 'c'

Static ReadonlyTHUMB_800x800_BOX

THUMB_800x800_BOX: "x" = 'x'

Static ReadonlyTHUMB_EMOJI_MARKUP

THUMB_EMOJI_MARKUP: "pfp_em" = 'pfp_em'

(non-standard) Emoji-based markup for profile photo

Static ReadonlyTHUMB_OUTLINE

THUMB_OUTLINE: "j" = 'j'

Static ReadonlyTHUMB_STICKER_MARKUP

THUMB_STICKER_MARKUP: "pfp_st" = 'pfp_st'

(non-standard) Sticker-based markup for profile photo

Static ReadonlyTHUMB_STRIP

THUMB_STRIP: "i" = 'i'

Static ReadonlyTHUMB_VIDEO_FULLSCREEN

THUMB_VIDEO_FULLSCREEN: "f" = 'f'

Fullscreen animation for Premium stickers

Static ReadonlyTHUMB_VIDEO_PREVIEW

THUMB_VIDEO_PREVIEW: "v" = 'v'

Trimmed and downscaled video previews

Static ReadonlyTHUMB_VIDEO_PROFILE

THUMB_VIDEO_PROFILE: "u" = 'u'

Animated profile pictures preview

Accessors

fileId

  • get fileId(): string

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

    Note: You can't use this file id to send a thumbnail, only to download it.

    Returns string

isVideo

  • get isVideo(): boolean

  • Returns boolean

path

  • get path(): string

  • If raw is tl.RawPhotoPathSize (i.e. raw.type === Thumbnail.THUMB_OUTLINE), this property will return raw SVG path of the preview.

    When downloading path thumbnails, a valid SVG file is returned.

    See also: https://core.telegram.org/api/files#vector-thumbnails

    Returns string

    Throws

    MtTypeAssertionError In case raw is not tl.RawPhotoPathSize

type

  • get type(): string

  • Thumbnail type

    Returns string

uniqueFileId

  • get uniqueFileId(): string

  • Get a unique File ID representing this thumbnail.

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors