InputInvoiceMessageContent
class InputInvoiceMessageContent implements InputMessageContentInterface
Represents the content of an invoice message to be sent as the result of an inline query.
Methods
No description
Product name, 1-32 characters.
Product description, 1-255 characters.
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
Payment provider token, obtained via @BotFather.
Three-letter ISO 4217 currency code, see more on currencies.
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.
Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
Optional. Photo size in bytes.
Optional. Photo width.
Optional. Photo height.
Optional. Pass True if you require the user's full name to complete the order.
Optional. Pass True if you require the user's phone number to complete the order.
Optional. Pass True if you require the user's email address to complete the order.
Optional. Pass True if you require the user's shipping address to complete the order.
Optional. Pass True if the user's phone number should be sent to provider.
Optional. Pass True if the user's email address should be sent to provider.
Optional. Pass True if the final price depends on the shipping method.
Details
at line 32
__construct(string $title, string $description, string $payload, string $provider_token, string $currency, LabeledPrice[] $prices, int|null $max_tip_amount = null, int[]|null $suggested_tip_amounts = null, string|null $provider_data = null, string|null $photo_url = null, int|null $photo_size = null, int|null $photo_width = null, int|null $photo_height = null, bool|null $need_name = null, bool|null $need_phone_number = null, bool|null $need_email = null, bool|null $need_shipping_address = null, bool|null $send_phone_number_to_provider = null, bool|null $send_email_to_provider = null, bool|null $is_flexible = null)
No description
at line 59
string
getTitle()
Product name, 1-32 characters.
at line 67
string
getDescription()
Product description, 1-255 characters.
at line 75
string
getPayload()
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
at line 83
string
getProviderToken()
Payment provider token, obtained via @BotFather.
at line 91
string
getCurrency()
Three-letter ISO 4217 currency code, see more on currencies.
at line 101
array
getPrices()
Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
at line 109
int|null
getMaxTipAmount()
Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.
at line 119
array|null
getSuggestedTipAmounts()
Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
at line 127
string|null
getProviderData()
Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
at line 135
string|null
getPhotoUrl()
Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
at line 143
int|null
getPhotoSize()
Optional. Photo size in bytes.
at line 151
int|null
getPhotoWidth()
Optional. Photo width.
at line 159
int|null
getPhotoHeight()
Optional. Photo height.
at line 167
bool|null
getNeedName()
Optional. Pass True if you require the user's full name to complete the order.
at line 175
bool|null
getNeedPhoneNumber()
Optional. Pass True if you require the user's phone number to complete the order.
at line 183
bool|null
getNeedEmail()
Optional. Pass True if you require the user's email address to complete the order.
at line 191
bool|null
getNeedShippingAddress()
Optional. Pass True if you require the user's shipping address to complete the order.
at line 199
bool|null
getSendPhoneNumberToProvider()
Optional. Pass True if the user's phone number should be sent to provider.
at line 207
bool|null
getSendEmailToProvider()
Optional. Pass True if the user's email address should be sent to provider.
at line 215
bool|null
getIsFlexible()
Optional. Pass True if the final price depends on the shipping method.