docs/dev.inmo.tgbotapi.requests.send.payments/SendInvoice

SendInvoice

data class SendInvoice(chatId: ChatId, title: String, description: String, payload: String, providerToken: String, currency: Currency, prices: List<LabeledPrice>, maxTipAmount: Int?, suggestedTipAmounts: List<Int>?, startParameter: StartParameter?, providerData: String?, requireName: Boolean, requirePhoneNumber: Boolean, requireEmail: Boolean, requireShippingAddress: Boolean, shouldSendPhoneNumberToProvider: Boolean, shouldSendEmailToProvider: Boolean, priceDependOnShipAddress: Boolean, disableNotification: Boolean, protectContent: Boolean, replyToMessageId: MessageIdentifier?, allowSendingWithoutReply: Boolean?, replyMarkup: InlineKeyboardMarkup?) : CommonSendInvoiceData, ChatRequest, DisableNotification, ReplyMessageId, ReplyMarkup, SendMessageRequest<ContentMessage<InvoiceContent>>

Parameters

providerData

JSON-ENCODED FIELD

Constructors

fun SendInvoice(chatId: ChatId, 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, disableNotification: Boolean = false, protectContent: Boolean = false, replyToMessageId: MessageIdentifier? = null, allowSendingWithoutReply: Boolean? = null, replyMarkup: InlineKeyboardMarkup? = null)

Functions

open override fun method(): String

open override fun setPhoto(photoUrl: String, photoSize: Long?, photoWidth: Int?, photoHeight: Int?)

open override fun unsetPhoto()

Properties

allowSendingWithoutReply

open override val allowSendingWithoutReply: Boolean? = null

open override val chatId: ChatId

open override val currency: Currency

open override val description: String

disableNotification

open override val disableNotification: Boolean = false

open override val maxTipAmount: Int? = null

open override val payload: String

open override var photoHeight: Int? = null

open override var photoSize: Long? = null

open override var photoUrl: String? = null

open override var photoWidth: Int? = null

priceDependOnShipAddress

open override val priceDependOnShipAddress: Boolean = false

open override val prices: List<LabeledPrice>

open override val protectContent: Boolean = false

open override val providerData: String? = null

open override val providerToken: String

open override val replyMarkup: InlineKeyboardMarkup? = null

replyToMessageId

open override val replyToMessageId: MessageIdentifier? = null

requestSerializer

open override val requestSerializer: SerializationStrategy<*>

open override val requireEmail: Boolean = false

open override val requireName: Boolean = false

requirePhoneNumber

open override val requirePhoneNumber: Boolean = false

requireShippingAddress

open override val requireShippingAddress: Boolean = false

resultDeserializer

open override val resultDeserializer: DeserializationStrategy<ContentMessage<InvoiceContent>>

shouldSendEmailToProvider

open override val shouldSendEmailToProvider: Boolean = false

shouldSendPhoneNumberToProvider

open override val shouldSendPhoneNumberToProvider: Boolean = false

val startParameter: StartParameter? = null

suggestedTipAmounts

open override val suggestedTipAmounts: List<Int>? = null

open override val title: String