Class: TD::Types::InputMessageContent::Invoice

Inherits:
TD::Types::InputMessageContent show all
Defined in:
lib/tdlib/types/input_message_content/invoice.rb

Overview

A message with an invoice; can be used only by bots.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#description ⇒ TD::Types::String

Product description; 0-255 characters.

Returns:

  • (TD::Types::String) —

    the current value of description



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def description
  @description
end

#invoice ⇒ TD::Types::Invoice

Invoice.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def invoice
  @invoice
end

The content of paid media attached to the invoice; pass null if none.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def paid_media
  @paid_media
end

Paid media caption; pass null to use an empty caption; 0-getOption(“message_caption_length_max”) characters.

Returns:



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def paid_media_caption
  @paid_media_caption
end

#payload ⇒ String

The invoice payload.

Returns:

  • (String) —

    the current value of payload



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def payload
  @payload
end

#photo_height ⇒ Integer

Product photo height.

Returns:

  • (Integer) —

    the current value of photo_height



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def photo_height
  @photo_height
end

#photo_size ⇒ Integer

Product photo size.

Returns:

  • (Integer) —

    the current value of photo_size



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def photo_size
  @photo_size
end

#photo_url ⇒ TD::Types::String?

Product photo URL; optional.

Returns:

  • (TD::Types::String, nil) —

    the current value of photo_url



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def photo_url
  @photo_url
end

#photo_width ⇒ Integer

Product photo width.

Returns:

  • (Integer) —

    the current value of photo_width



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def photo_width
  @photo_width
end

#provider_data ⇒ TD::Types::String

JSON-encoded data about the invoice, which will be shared with the payment provider.

Returns:

  • (TD::Types::String) —

    the current value of provider_data



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def provider_data
  @provider_data
end

#provider_token ⇒ TD::Types::String?

Payment provider token; may be empty for payments in Telegram Stars.

Returns:

  • (TD::Types::String, nil) —

    the current value of provider_token



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def provider_token
  @provider_token
end

#start_parameter ⇒ TD::Types::String

Unique invoice bot deep link parameter for the generation of this invoice. If empty, it would be possible to pay directly from forwards of the invoice message.

Returns:

  • (TD::Types::String) —

    the current value of start_parameter



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def start_parameter
  @start_parameter
end

#title ⇒ TD::Types::String

Product title; 1-32 characters.

Returns:

  • (TD::Types::String) —

    the current value of title



21
22
23
 
# File 'lib/tdlib/types/input_message_content/invoice.rb', line 21

def title
  @title
end