Class Photo

A photo

Hierarchy (View Summary)

Constructors

constructor

Properties

dcId? fileSize? height location media? raw type width

Accessors

date fileId hasSpoiler id inputMedia inputPhoto isAnimatedAvatar isMarkupAvatar thumbnails ttlSeconds uniqueFileId

Methods

getThumbnail

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

Biggest available photo height

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.

Optional Readonlymedia

media?: RawMessageMediaPhoto

Readonlyraw

raw: RawPhoto

Readonlytype

type: "photo" = ...

Readonlywidth

width: number

Biggest available photo width

Accessors

date

  • get date(): Date

  • Date this photo was sent

    Returns Date

fileId

  • get fileId(): string

  • Get TDLib and Bot API compatible File ID representing this photo's best thumbnail.

    Returns string

hasSpoiler

  • get hasSpoiler(): boolean

  • Whether this photo is hidden with a spoiler

    Returns boolean

id

  • get id(): Long

  • Photo ID

    Returns Long

inputMedia

  • get inputMedia(): TypeInputMedia

  • Input media generated from this object, to be used in InputMediaLike and TelegramClient.sendMedia

    Returns TypeInputMedia

inputPhoto

  • get inputPhoto(): TypeInputPhoto

  • Input photo generated from this object.

    Returns TypeInputPhoto

isAnimatedAvatar

  • get isAnimatedAvatar(): boolean

  • Whether this photo is an animated profile picture

    Returns boolean

isMarkupAvatar

  • get isMarkupAvatar(): boolean

  • Whether this photo is an animated profile picture, built from an emoji/sticker markup

    Returns boolean

thumbnails

  • get thumbnails(): readonly Thumbnail[]

  • Available thumbnails.

    Note: This list will also contain the largest thumbnail that is represented by the current object.

    Returns readonly Thumbnail[]

ttlSeconds

  • get ttlSeconds(): null | number

  • For self-destructing photos, TTL in seconds

    Returns null | number

uniqueFileId

  • get uniqueFileId(): string

  • Get TDLib and Bot API compatible Unique File ID representing this photo's best thumbnail.

    Returns string

Methods

getThumbnail

  • getThumbnail(type: string): null | Thumbnail

  • Get a photo 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