Class Thumbnail

One size of some thumbnail

Hierarchy (View Summary)

FileLocation
- Thumbnail

Constructors

constructor

new Thumbnail(
    media:
        | RawPhoto
        | RawDocument
        | RawStickerSet
        | RawMessageExtendedMediaPreview,
    sz: TypePhotoSize | TypeVideoSize,
): Thumbnail
Parameters
- media: RawPhoto | RawDocument | RawStickerSet | RawMessageExtendedMediaPreview
- sz: TypePhotoSize | TypeVideoSize
Returns Thumbnail
Overrides FileLocation.constructor
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:60

Properties

`Optional` `Readonly`dcId

dcId?: number

DC ID of the file, when available

`Optional` `Readonly`fileSize

fileSize?: number

File size in bytes, when available

`Readonly`height

height: number

Thumbnail height (NaN for THUMB_OUTLINE and THUMB_STRIP)

`Readonly`location

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.

`Readonly`raw

raw: TypePhotoSize | TypeVideoSize

`Readonly`width

width: number

Thumbnail width (NaN for THUMB_OUTLINE and THUMB_STRIP)

`Static` `Readonly`THUMB_100x100_BOX

THUMB_100x100_BOX: "s" = 's'

`Static` `Readonly`THUMB_1280x1280_BOX

THUMB_1280x1280_BOX: "y" = 'y'

`Static` `Readonly`THUMB_1280x1280_CROP

THUMB_1280x1280_CROP: "d" = 'd'

`Static` `Readonly`THUMB_160x160_CROP

THUMB_160x160_CROP: "a" = 'a'

`Static` `Readonly`THUMB_2560x2560_BOX

THUMB_2560x2560_BOX: "w" = 'w'

`Static` `Readonly`THUMB_320x320_BOX

THUMB_320x320_BOX: "m" = 'm'

`Static` `Readonly`THUMB_320x320_CROP

THUMB_320x320_CROP: "b" = 'b'

`Static` `Readonly`THUMB_640x640_CROP

THUMB_640x640_CROP: "c" = 'c'

`Static` `Readonly`THUMB_800x800_BOX

THUMB_800x800_BOX: "x" = 'x'

`Static` `Readonly`THUMB_EMOJI_MARKUP

THUMB_EMOJI_MARKUP: "pfp_em" = 'pfp_em'

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

`Static` `Readonly`THUMB_OUTLINE

THUMB_OUTLINE: "j" = 'j'

`Static` `Readonly`THUMB_STICKER_MARKUP

THUMB_STICKER_MARKUP: "pfp_st" = 'pfp_st'

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

`Static` `Readonly`THUMB_STRIP

THUMB_STRIP: "i" = 'i'

`Static` `Readonly`THUMB_VIDEO_FULLSCREEN

THUMB_VIDEO_FULLSCREEN: "f" = 'f'

Fullscreen animation for Premium stickers

`Static` `Readonly`THUMB_VIDEO_PREVIEW

THUMB_VIDEO_PREVIEW: "v" = 'v'

Trimmed and downscaled video previews

`Static` `Readonly`THUMB_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
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:197

isVideo

get isVideo(): boolean
Returns boolean
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:156

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
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:184

type

get type(): string
Thumbnail type

Returns string
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:163

uniqueFileId

get uniqueFileId(): string
Get a unique File ID representing this thumbnail.

Returns string
- Defined in packages/core/src/highlevel/types/media/thumbnail.ts:244

Class Thumbnail

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns Thumbnail

Properties

Optional ReadonlydcId

Optional ReadonlyfileSize

Readonlyheight

Readonlylocation

Readonlyraw

Readonlywidth

Static ReadonlyTHUMB_100x100_BOX

Static ReadonlyTHUMB_1280x1280_BOX

Static ReadonlyTHUMB_1280x1280_CROP

Static ReadonlyTHUMB_160x160_CROP

Static ReadonlyTHUMB_2560x2560_BOX

Static ReadonlyTHUMB_320x320_BOX

Static ReadonlyTHUMB_320x320_CROP

Static ReadonlyTHUMB_640x640_CROP

Static ReadonlyTHUMB_800x800_BOX

Static ReadonlyTHUMB_EMOJI_MARKUP

Static ReadonlyTHUMB_OUTLINE

Static ReadonlyTHUMB_STICKER_MARKUP

Static ReadonlyTHUMB_STRIP

Static ReadonlyTHUMB_VIDEO_FULLSCREEN

Static ReadonlyTHUMB_VIDEO_PREVIEW

Static ReadonlyTHUMB_VIDEO_PROFILE

Accessors

fileId

Returns string

isVideo

Returns boolean

path

Returns string

Throws

type

Returns string

uniqueFileId

Returns string

Settings

On This Page

`Optional` `Readonly`dcId

`Optional` `Readonly`fileSize

`Readonly`height

`Readonly`location

`Readonly`raw

`Readonly`width

`Static` `Readonly`THUMB_100x100_BOX

`Static` `Readonly`THUMB_1280x1280_BOX

`Static` `Readonly`THUMB_1280x1280_CROP

`Static` `Readonly`THUMB_160x160_CROP

`Static` `Readonly`THUMB_2560x2560_BOX

`Static` `Readonly`THUMB_320x320_BOX

`Static` `Readonly`THUMB_320x320_CROP

`Static` `Readonly`THUMB_640x640_CROP

`Static` `Readonly`THUMB_800x800_BOX

`Static` `Readonly`THUMB_EMOJI_MARKUP

`Static` `Readonly`THUMB_OUTLINE

`Static` `Readonly`THUMB_STICKER_MARKUP

`Static` `Readonly`THUMB_STRIP

`Static` `Readonly`THUMB_VIDEO_FULLSCREEN

`Static` `Readonly`THUMB_VIDEO_PREVIEW

`Static` `Readonly`THUMB_VIDEO_PROFILE