GramIO API Reference / @gramio/contexts/dist / SuggestedPostPaid

Class: SuggestedPostPaid

Defined in: contexts/index.d.ts:2738

Describes a service message about a successful payment for a suggested post.

Documentation

Constructors

Constructor

new SuggestedPostPaid(payload): SuggestedPostPaid

Defined in: contexts/index.d.ts:2740

Parameters

Parameter	Type
payload	TelegramSuggestedPostPaid

Returns

SuggestedPostPaid

Properties

Property	Type	Defined in
payload	TelegramSuggestedPostPaid	contexts/index.d.ts:2739

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: contexts/index.d.ts:2742

MDN

Returns

string

---

amount

Get Signature

get amount(): number

Defined in: contexts/index.d.ts:2750

Optional. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only

Returns

number

---

currency

Get Signature

get currency(): TelegramSuggestedPostPaidCurrency

Defined in: contexts/index.d.ts:2746

Currency in which the payment was made. Currently, one of "XTR" for Telegram Stars or "TON" for toncoins

Returns

TelegramSuggestedPostPaidCurrency

---

starAmount

Get Signature

get starAmount(): TelegramStarAmount

Defined in: contexts/index.d.ts:2754

Optional. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only

Returns

TelegramStarAmount