Class PaidMedia

Hierarchy (View Summary)

Base
- PaidMedia

Index

Constructors

Properties

duration? height? photo? video? width?

Accessors

Methods

_clone _patch _update isPhoto isPreview isVideo toJSON valueOf

Constructors

constructor

new PaidMedia(client: TelegramClient | BaseClient, data: PaidMedia): PaidMedia
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: PaidMedia
  Data about the describes paid media
Returns PaidMedia
Overrides Base.constructor

Properties

`Optional`duration

duration?: number

Duration of the media in seconds as defined by the sender

`Optional`height

height?: number

Media height as defined by the sender

`Optional`photo

photo?: Photo[]

The photo

`Optional`video

video?: Video

The video

`Optional`width

width?: number

Media width as defined by the sender

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from Base.client

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from Base._clone

_patch

_patch(data: PaidMedia): PaidMedia
Parameters
- data: PaidMedia
  Data about the describes paid media
Returns PaidMedia
Overrides Base._patch

`Protected`_update

_update(data: Record<string, any>): Base
Protected
Updates the current instance with new data and returns a clone of the updated instance
Parameters
- data: Record<string, any>
  The data to update the instance with
Returns Base
A clone of the updated instance

Inherited from Base._update

isPhoto

isPhoto(): this is PaidMedia & { photo: Photo[] }
Returns this is PaidMedia & { photo: Photo[] }

isPreview

isPreview(): this is PaidMedia & { photo?: undefined; video?: undefined }
Returns this is PaidMedia & { photo?: undefined; video?: undefined }

isVideo

isVideo(): this is PaidMedia & { video: Video }
Returns this is PaidMedia & { video: Video }

toJSON

toJSON(
propsRecursive?: boolean,
...props: Record<string, string | boolean>[],
): Record<string, any>
Flatten an object. Any properties that are collections will get converted to an array of keys.
Parameters
- OptionalpropsRecursive: boolean
  Optional. If true, calls toJSON method on nested objects.
- ...props: Record<string, string | boolean>[]
  Optional. Specific properties to include/exclude, or rename.
Returns Record<string, any>
Flattened object.

Inherited from Base.toJSON

valueOf

valueOf(): string | null
Returns the id instance Chat, User, ChatMember and other

Returns string | null
Inherited from Base.valueOf