SendInvoice

@Serializable
data class SendInvoice(val chatId: IdChatIdentifier, val title: String, val description: String, val payload: String, val providerToken: String?, val currency: Currency, val prices: List<LabeledPrice>, val maxTipAmount: Int? = null, val suggestedTipAmounts: List<Int>? = null, val startParameter: StartParameter? = null, val providerData: String? = null, val requireName: Boolean = false, val requirePhoneNumber: Boolean = false, val requireEmail: Boolean = false, val requireShippingAddress: Boolean = false, val shouldSendPhoneNumberToProvider: Boolean = false, val shouldSendEmailToProvider: Boolean = false, val priceDependOnShipAddress: Boolean = false, val threadId: MessageThreadId? = chatId.threadId, val disableNotification: Boolean = false, val protectContent: Boolean = false, val effectId: EffectId? = null, val replyParameters: ReplyParameters? = null, val replyMarkup: InlineKeyboardMarkup? = null) : CommonSendInvoiceData, ChatRequest, DisableNotification, WithReplyParameters, WithReplyMarkup, SendMessageRequest<ContentMessage<InvoiceContent>> , OptionallyWithEffectRequest<ContentMessage<InvoiceContent>>

Parameters

providerData
  • JSON-ENCODED FIELD

Constructors

Link copied to clipboard
constructor(chatId: IdChatIdentifier, title: String, description: String, payload: String, prices: List<LabeledPrice>, maxTipAmount: Int? = null, suggestedTipAmounts: List<Int>? = null, providerData: String? = null, requireName: Boolean = false, requirePhoneNumber: Boolean = false, requireEmail: Boolean = false, requireShippingAddress: Boolean = false, shouldSendPhoneNumberToProvider: Boolean = false, shouldSendEmailToProvider: Boolean = false, priceDependOnShipAddress: Boolean = false, threadId: MessageThreadId? = chatId.threadId, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: EffectId? = null, replyParameters: ReplyParameters? = null, replyMarkup: InlineKeyboardMarkup? = null)
constructor(chatId: IdChatIdentifier, title: String, description: String, payload: String, providerToken: String?, currency: Currency, prices: List<LabeledPrice>, maxTipAmount: Int? = null, suggestedTipAmounts: List<Int>? = null, startParameter: StartParameter? = null, providerData: String? = null, requireName: Boolean = false, requirePhoneNumber: Boolean = false, requireEmail: Boolean = false, requireShippingAddress: Boolean = false, shouldSendPhoneNumberToProvider: Boolean = false, shouldSendEmailToProvider: Boolean = false, priceDependOnShipAddress: Boolean = false, threadId: MessageThreadId? = chatId.threadId, disableNotification: Boolean = false, protectContent: Boolean = false, effectId: EffectId? = null, replyParameters: ReplyParameters? = null, replyMarkup: InlineKeyboardMarkup? = null)

Properties

Link copied to clipboard
Link copied to clipboard
@SerialName(value = "chat_id")
open override val chatId: IdChatIdentifier
Link copied to clipboard
@SerialName(value = "currency")
open override val currency: Currency
Link copied to clipboard
@SerialName(value = "description")
open override val description: String
Link copied to clipboard
@SerialName(value = "disable_notification")
open override val disableNotification: Boolean = false
Link copied to clipboard
@SerialName(value = "message_effect_id")
open override val effectId: EffectId? = null
Link copied to clipboard
@SerialName(value = "max_tip_amount")
open override val maxTipAmount: Int? = null
Link copied to clipboard
@SerialName(value = "payload")
open override val payload: String
Link copied to clipboard
@SerialName(value = "photo_height")
open override var photoHeight: Int?
Link copied to clipboard
@SerialName(value = "photo_size")
open override var photoSize: Long?
Link copied to clipboard
@SerialName(value = "photo_url")
open override var photoUrl: String?
Link copied to clipboard
@SerialName(value = "photo_width")
open override var photoWidth: Int?
Link copied to clipboard
@SerialName(value = "is_flexible")
open override val priceDependOnShipAddress: Boolean = false
Link copied to clipboard
@Serializable(with = LabeledPricesSerializer::class)
@SerialName(value = "prices")
open override val prices: List<LabeledPrice>
Link copied to clipboard
@SerialName(value = "protect_content")
open override val protectContent: Boolean = false
Link copied to clipboard
@SerialName(value = "provider_data")
open override val providerData: String? = null
Link copied to clipboard
@SerialName(value = "provider_token")
open override val providerToken: String?
Link copied to clipboard
@SerialName(value = "reply_markup")
open override val replyMarkup: InlineKeyboardMarkup? = null
Link copied to clipboard
@SerialName(value = "reply_parameters")
open override val replyParameters: ReplyParameters? = null
Link copied to clipboard
Link copied to clipboard
open override val requestSerializer: SerializationStrategy<*>
Link copied to clipboard
@SerialName(value = "need_email")
open override val requireEmail: Boolean = false
Link copied to clipboard
@SerialName(value = "need_name")
open override val requireName: Boolean = false
Link copied to clipboard
@SerialName(value = "need_phone_number")
open override val requirePhoneNumber: Boolean = false
Link copied to clipboard
@SerialName(value = "need_shipping_address")
open override val requireShippingAddress: Boolean = false
Link copied to clipboard
open override val resultDeserializer: DeserializationStrategy<ContentMessage<InvoiceContent>>
Link copied to clipboard
@SerialName(value = "send_email_to_provider")
open override val shouldSendEmailToProvider: Boolean = false
Link copied to clipboard
@SerialName(value = "send_phone_number_to_provider")
open override val shouldSendPhoneNumberToProvider: Boolean = false
Link copied to clipboard
@SerialName(value = "start_parameter")
val startParameter: StartParameter? = null
Link copied to clipboard
@SerialName(value = "suggested_tip_amounts")
open override val suggestedTipAmounts: List<Int>? = null
Link copied to clipboard
@SerialName(value = "message_thread_id")
open override val threadId: MessageThreadId?
Link copied to clipboard
@SerialName(value = "title")
open override val title: String

Functions

Link copied to clipboard
Link copied to clipboard
open override fun method(): String
Link copied to clipboard
open override fun setPhoto(photoUrl: String, photoSize: Long?, photoWidth: Int?, photoHeight: Int?)
Link copied to clipboard
open override fun unsetPhoto()