ExGram.Model.OwnedGiftRegular (ex_gram v0.65.0)

Copy Markdown View Source

Describes a regular gift owned by a user or a chat.

Check the documentation of this model on Telegram Bot API

  • type: Type of the gift, always "regular”
  • gift: Information about the regular gift
  • send_date: Date the gift was sent in Unix time
  • owned_gift_id (optional): Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
  • sender_user (optional): Optional. Sender of the gift if it is a known user
  • text (optional): Optional. Text of the message that was added to the gift
  • entities (optional): Optional. Special entities that appear in the text
  • is_private (optional): Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
  • is_saved (optional): Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
  • can_be_upgraded (optional): Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only
  • was_refunded (optional): Optional. True, if the gift was refunded and isn't available anymore
  • convert_star_count (optional): 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
  • prepaid_upgrade_star_count (optional): Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift
  • is_upgrade_separate (optional): Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only
  • unique_gift_number (optional): Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift

Summary

Types

t()

Functions

decode_as()

Types

t()

@type t() :: %ExGram.Model.OwnedGiftRegular{
  can_be_upgraded: boolean() | nil,
  convert_star_count: integer() | nil,
  entities: [ExGram.Model.MessageEntity.t()] | nil,
  gift: ExGram.Model.Gift.t(),
  is_private: boolean() | nil,
  is_saved: boolean() | nil,
  is_upgrade_separate: boolean() | nil,
  owned_gift_id: String.t() | nil,
  prepaid_upgrade_star_count: integer() | nil,
  send_date: integer(),
  sender_user: ExGram.Model.User.t() | nil,
  text: String.t() | nil,
  type: String.t(),
  unique_gift_number: integer() | nil,
  was_refunded: boolean() | nil
}

Functions

decode_as()