Class OwnedGifts

Hierarchy (View Summary)

Base
- OwnedGifts

Index

Constructors

Properties

gifts? nextOffset? totalCount

Accessors

Methods

_clone _patch _update toJSON valueOf

Constructors

constructor

new OwnedGifts(
client: TelegramClient | BaseClient,
data: OwnedGifts,
): OwnedGifts
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: OwnedGifts
  Data about the list of gifts received and owned by a user or a chat.
Returns OwnedGifts
Overrides Base.constructor

Properties

`Optional`gifts

gifts?: (OwnedGiftRegular | OwnedGiftUnique)[]

The list of gifts

`Optional`nextOffset

nextOffset?: string

Offset for the next request. If empty, then there are no more results

totalCount

totalCount: number

The total number of gifts owned by the user or the chat

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

`Protected`_patch

_patch(data: Record<string, any>): Record<string, any>
Protected
Patches the current instance with new data
Parameters
- data: Record<string, any>
  The data to patch the instance with
Returns Record<string, any>
The patched data

Inherited from 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

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