Class ChatBoostSource

Hierarchy (View Summary)

Base
- ChatBoostSource

Index

Constructors

Properties

giveawayId? starCount? unclaimed user?

Accessors

Methods

_clone _patch _update isGiveaway isPremiumAndGift toJSON valueOf

Constructors

constructor

new ChatBoostSource(
client: TelegramClient | BaseClient,
data: ChatBoostSource,
): ChatBoostSource
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: ChatBoostSource
  Data about the boost source
Returns ChatBoostSource
Overrides Base.constructor

Properties

`Optional`giveawayId

giveawayId?: string

Identifier of a message in the chat with the giveaway; the message could have been deleted already

`Optional`starCount

starCount?: number

The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only

unclaimed

unclaimed: boolean

True, if the giveaway was completed, but there was no user to win the prize

`Optional`user

user?: User

User that boosted 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

_patch

_patch(data: ChatBoostSource): ChatBoostSource
Parameters
- data: ChatBoostSource
  Data about the boost source
Returns ChatBoostSource
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

isGiveaway

isGiveaway(): this is ChatBoostSource & { giveawayId: string }
Returns this is ChatBoostSource & { giveawayId: string }

isPremiumAndGift

isPremiumAndGift(): this is ChatBoostSource & { giveawayId: string; user: User }
Returns this is ChatBoostSource & { giveawayId: string; user: User }

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(): null | string
Returns the id instance Chat, User, ChatMember and other

Returns null | string
Inherited from Base.valueOf