GramIO API Reference / gramio/dist / TelegramOwnedGiftRegular
Interface: TelegramOwnedGiftRegular
Defined in: @gramio/types/out/objects.d.ts:4928
Describes a regular gift owned by a user or a chat.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
can_be_upgraded? | true | Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4968 |
convert_star_count? | number | Optional. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4976 |
entities? | TelegramMessageEntity[] | Optional. Special entities that appear in the text | @gramio/types/out/objects.d.ts:4956 |
gift | TelegramGift | Information about the regular gift | @gramio/types/out/objects.d.ts:4936 |
is_private? | true | Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | @gramio/types/out/objects.d.ts:4960 |
is_saved? | true | Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4964 |
is_upgrade_separate? | true | Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4984 |
owned_gift_id? | string | Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only | @gramio/types/out/objects.d.ts:4940 |
prepaid_upgrade_star_count? | number | Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift | @gramio/types/out/objects.d.ts:4980 |
send_date | number | Date the gift was sent in Unix time | @gramio/types/out/objects.d.ts:4948 |
sender_user? | TelegramUser | Optional. Sender of the gift if it is a known user | @gramio/types/out/objects.d.ts:4944 |
text? | string | Optional. Text of the message that was added to the gift | @gramio/types/out/objects.d.ts:4952 |
type | "regular" | Type of the gift, always “regular” | @gramio/types/out/objects.d.ts:4932 |
unique_gift_number? | number | Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift | @gramio/types/out/objects.d.ts:4988 |
was_refunded? | true | Optional. True, if the gift was refunded and isn't available anymore | @gramio/types/out/objects.d.ts:4972 |