ExGram.Model.Gift (ex_gram v0.64.0)

Copy Markdown View Source

This object represents a gift that can be sent by the bot.

Check the documentation of this model on Telegram Bot API

  • id: Unique identifier of the gift
  • sticker: The sticker that represents the gift
  • star_count: The number of Telegram Stars that must be paid to send the sticker
  • upgrade_star_count (optional): Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
  • is_premium (optional): Optional. True, if the gift can only be purchased by Telegram Premium subscribers
  • has_colors (optional): Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance
  • total_count (optional): Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only
  • remaining_count (optional): Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only
  • personal_total_count (optional): Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only
  • personal_remaining_count (optional): Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only
  • background (optional): Optional. Background of the gift
  • unique_gift_variant_count (optional): Optional. The total number of different unique gifts that can be obtained by upgrading the gift
  • publisher_chat (optional): Optional. Information about the chat that published the gift

Summary

Types

t()

Functions

decode_as()

Types

t()

@type t() :: %ExGram.Model.Gift{
  background: ExGram.Model.GiftBackground.t() | nil,
  has_colors: boolean() | nil,
  id: String.t(),
  is_premium: boolean() | nil,
  personal_remaining_count: integer() | nil,
  personal_total_count: integer() | nil,
  publisher_chat: ExGram.Model.Chat.t() | nil,
  remaining_count: integer() | nil,
  star_count: integer(),
  sticker: ExGram.Model.Sticker.t(),
  total_count: integer() | nil,
  unique_gift_variant_count: integer() | nil,
  upgrade_star_count: integer() | nil
}

Functions

decode_as()