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

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 replyToMessageId: MessageId? = null, val allowSendingWithoutReply: Boolean? = null, val replyMarkup: InlineKeyboardMarkup? = null) : CommonSendInvoiceData, ChatRequest, DisableNotification, ReplyMessageId, WithReplyMarkup, SendMessageRequest<ContentMessage<InvoiceContent>>

Parameters

providerData

JSON-ENCODED FIELD

Constructors

fun SendInvoice(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, replyToMessageId: MessageId? = 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: IdChatIdentifier

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

@Serializable(with = LabeledPricesSerializer::class)

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: MessageId? = 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 threadId: MessageThreadId?

open override val title: String

Extensions

asCreateInvoiceLink

inline fun CommonSendInvoiceData.asCreateInvoiceLink(): CreateInvoiceLink?

asInputInvoiceMessageContent

inline fun CommonSendInvoiceData.asInputInvoiceMessageContent(): InputInvoiceMessageContent?

inline fun CommonSendInvoiceData.asSendInvoice(): SendInvoice?

createInvoiceLinkOrNull

inline fun CommonSendInvoiceData.createInvoiceLinkOrNull(): CreateInvoiceLink?

createInvoiceLinkOrThrow

inline fun CommonSendInvoiceData.createInvoiceLinkOrThrow(): CreateInvoiceLink

ifCreateInvoiceLink

inline fun <T> CommonSendInvoiceData.ifCreateInvoiceLink(block: (CreateInvoiceLink) -> T): T?

ifInputInvoiceMessageContent

inline fun <T> CommonSendInvoiceData.ifInputInvoiceMessageContent(block: (InputInvoiceMessageContent) -> T): T?

inline fun <T> CommonSendInvoiceData.ifSendInvoice(block: (SendInvoice) -> T): T?

inputInvoiceMessageContentOrNull

inline fun CommonSendInvoiceData.inputInvoiceMessageContentOrNull(): InputInvoiceMessageContent?

inputInvoiceMessageContentOrThrow

inline fun CommonSendInvoiceData.inputInvoiceMessageContentOrThrow(): InputInvoiceMessageContent

fun Currencied.javaCurrency(): Currency

requireCreateInvoiceLink

inline fun CommonSendInvoiceData.requireCreateInvoiceLink(): CreateInvoiceLink

requireInputInvoiceMessageContent

inline fun CommonSendInvoiceData.requireInputInvoiceMessageContent(): InputInvoiceMessageContent

requireSendInvoice

inline fun CommonSendInvoiceData.requireSendInvoice(): SendInvoice

sendInvoiceOrNull

inline fun CommonSendInvoiceData.sendInvoiceOrNull(): SendInvoice?

sendInvoiceOrThrow

inline fun CommonSendInvoiceData.sendInvoiceOrThrow(): SendInvoice

whenCreateInvoiceLink

inline fun <T> CommonSendInvoiceData.whenCreateInvoiceLink(block: (CreateInvoiceLink) -> T): T?

whenInputInvoiceMessageContent

inline fun <T> CommonSendInvoiceData.whenInputInvoiceMessageContent(block: (InputInvoiceMessageContent) -> T): T?

whenSendInvoice

inline fun <T> CommonSendInvoiceData.whenSendInvoice(block: (SendInvoice) -> T): T?