final case class SendInvoice(chatId: Long, title: String, description: String, payload: String, providerToken: String, startParameter: String, currency: Currency, prices: Seq[LabeledPrice], providerData: Option[String] = None, photoUrl: Option[String] = None, photoSize: Option[Int] = None, photoWidth: Option[Int] = None, photoHeight: Option[Int] = None, needName: Option[Boolean] = None, needPhoneNumber: Option[Boolean] = None, needEmail: Option[Boolean] = None, needShippingAddress: Option[Boolean] = None, isFlexible: Option[Boolean] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int] = None, replyMarkup: Option[ReplyMarkup] = None) extends Product with Serializable
Use this method to send invoices. On success, the sent Message is returned.
- chatId
Unique identifier for the target private chat
- title
Product name
- description
Product description
- payload
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
- providerToken
Payments provider token, obtained via Botfather
- startParameter
Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
- currency
Three-letter ISO 4217 currency code, see more on currencies
- prices
Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
- providerData
JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
- photoUrl
URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
- photoSize
Photo size
- photoWidth
Photo width
- photoHeight
Photo height
- needName
Pass True, if you require the user's full name to complete the order
- needPhoneNumber
Pass True, if you require the user's phone number to complete the order
- needEmail
Pass True, if you require the user's email to complete the order
- needShippingAddress
Pass True, if you require the user's shipping address to complete the order
- isFlexible
Pass True, if the final price depends on the shipping method
- disableNotification
Sends the message silently. Users will receive a notification with no sound.
- replyToMessageId
If the message is a reply, ID of the original message
- replyMarkup
A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
- Alphabetic
- By Inheritance
- SendInvoice
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new SendInvoice(chatId: Long, title: String, description: String, payload: String, providerToken: String, startParameter: String, currency: Currency, prices: Seq[LabeledPrice], providerData: Option[String] = None, photoUrl: Option[String] = None, photoSize: Option[Int] = None, photoWidth: Option[Int] = None, photoHeight: Option[Int] = None, needName: Option[Boolean] = None, needPhoneNumber: Option[Boolean] = None, needEmail: Option[Boolean] = None, needShippingAddress: Option[Boolean] = None, isFlexible: Option[Boolean] = None, disableNotification: Option[Boolean] = None, replyToMessageId: Option[Int] = None, replyMarkup: Option[ReplyMarkup] = None)
- chatId
Unique identifier for the target private chat
- title
Product name
- description
Product description
- payload
Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
- providerToken
Payments provider token, obtained via Botfather
- startParameter
Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter
- currency
Three-letter ISO 4217 currency code, see more on currencies
- prices
Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
- providerData
JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
- photoUrl
URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
- photoSize
Photo size
- photoWidth
Photo width
- photoHeight
Photo height
- needName
Pass True, if you require the user's full name to complete the order
- needPhoneNumber
Pass True, if you require the user's phone number to complete the order
- needEmail
Pass True, if you require the user's email to complete the order
- needShippingAddress
Pass True, if you require the user's shipping address to complete the order
- isFlexible
Pass True, if the final price depends on the shipping method
- disableNotification
Sends the message silently. Users will receive a notification with no sound.
- replyToMessageId
If the message is a reply, ID of the original message
- replyMarkup
A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val chatId: Long
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val currency: Currency
- val description: String
- val disableNotification: Option[Boolean]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val isFlexible: Option[Boolean]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val needEmail: Option[Boolean]
- val needName: Option[Boolean]
- val needPhoneNumber: Option[Boolean]
- val needShippingAddress: Option[Boolean]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val payload: String
- val photoHeight: Option[Int]
- val photoSize: Option[Int]
- val photoUrl: Option[String]
- val photoWidth: Option[Int]
- val prices: Seq[LabeledPrice]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val providerData: Option[String]
- val providerToken: String
- val replyMarkup: Option[ReplyMarkup]
- val replyToMessageId: Option[Int]
- val startParameter: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val title: String
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()