telegramium.bots.ReplyParameters.scala Maven / Gradle / Ivy

Go to download
package telegramium.bots

/** Describes reply parameters for the message that is being sent.
  *
  * @param messageId
  *   Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
  * @param chatId
  *   Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of
  *   the channel (in the format @channelusername). Not supported for messages sent on behalf of a business
  *   account.
  * @param allowSendingWithoutReply
  *   Optional. Pass True if the message should be sent even if the specified message to be replied to is not found.
  *   Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business
  *   account.
  * @param quote
  *   Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be
  *   an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and
  *   custom_emoji entities. The message will fail to send if the quote isn't found in the original message.
  * @param quoteParseMode
  *   Optional. Mode for parsing entities in the quote. See formatting options for more details.
  * @param quoteEntities
  *   Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of
  *   quote_parse_mode.
  * @param quotePosition
  *   Optional. Position of the quote in the original message in UTF-16 code units
  */
final case class ReplyParameters(
  messageId: Int,
  chatId: Option[ChatId] = Option.empty,
  allowSendingWithoutReply: Option[Boolean] = Option.empty,
  quote: Option[String] = Option.empty,
  quoteParseMode: Option[ParseMode] = Option.empty,
  quoteEntities: List[iozhik.OpenEnum[MessageEntity]] = List.empty,
  quotePosition: Option[Int] = Option.empty
)