tgbotapi.core/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 allowPaidBroadcast: 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

constructor(chatId: IdChatIdentifier, title: String, description: String, payload: String, price: LabeledPrice, startParameter: StartParameter? = null, providerData: String? = null, threadId: MessageThreadId? = chatId.threadId, disableNotification: Boolean = false, protectContent: Boolean = false, allowPaidBroadcast: 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, allowPaidBroadcast: Boolean = false, effectId: EffectId? = null, replyParameters: ReplyParameters? = null, replyMarkup: InlineKeyboardMarkup? = null)

Properties

allowPaidBroadcast

@SerialName(value = "allow_paid_broadcast")

open override val allowPaidBroadcast: Boolean = false

allowSendingWithoutReply

open val allowSendingWithoutReply: Boolean?

@SerialName(value = "chat_id")

open override val chatId: IdChatIdentifier

@SerialName(value = "currency")

open override val currency: Currency

@SerialName(value = "description")

open override val description: String

disableNotification

@SerialName(value = "disable_notification")

open override val disableNotification: Boolean = false

@SerialName(value = "message_effect_id")

open override val effectId: EffectId? = null

@SerialName(value = "max_tip_amount")

open override val maxTipAmount: Int? = null

@SerialName(value = "payload")

open override val payload: String

@SerialName(value = "photo_height")

open override var photoHeight: Int?

@SerialName(value = "photo_size")

open override var photoSize: Long?

@SerialName(value = "photo_url")

open override var photoUrl: String?

@SerialName(value = "photo_width")

open override var photoWidth: Int?

priceDependOnShipAddress

@SerialName(value = "is_flexible")

open override val priceDependOnShipAddress: Boolean = false

@Serializable(with = LabeledPricesSerializer::class)

@SerialName(value = "prices")

open override val prices: List<LabeledPrice>

@SerialName(value = "protect_content")

open override val protectContent: Boolean = false

@SerialName(value = "provider_data")

open override val providerData: String? = null

@SerialName(value = "provider_token")

open override val providerToken: String?

@SerialName(value = "reply_markup")

open override val replyMarkup: InlineKeyboardMarkup? = null

replyParameters

@SerialName(value = "reply_parameters")

open override val replyParameters: ReplyParameters? = null

replyToMessageId

open val replyToMessageId: MessageId?

requestSerializer

open override val requestSerializer: SerializationStrategy<*>

@SerialName(value = "need_email")

open override val requireEmail: Boolean = false

@SerialName(value = "need_name")

open override val requireName: Boolean = false

requirePhoneNumber

@SerialName(value = "need_phone_number")

open override val requirePhoneNumber: Boolean = false

requireShippingAddress

@SerialName(value = "need_shipping_address")

open override val requireShippingAddress: Boolean = false

resultDeserializer

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

shouldSendEmailToProvider

@SerialName(value = "send_email_to_provider")

open override val shouldSendEmailToProvider: Boolean = false

shouldSendPhoneNumberToProvider

@SerialName(value = "send_phone_number_to_provider")

open override val shouldSendPhoneNumberToProvider: Boolean = false

@SerialName(value = "start_parameter")

val startParameter: StartParameter? = null

suggestedTipAmounts

@SerialName(value = "suggested_tip_amounts")

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

@SerialName(value = "message_thread_id")

open override val threadId: MessageThreadId?

@SerialName(value = "title")

open override val title: String

Functions

fun Currencied.javaCurrency(): Currency

open override fun method(): String

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

open override fun unsetPhoto()