EditMessageCaptionRequest

data class EditMessageCaptionRequest(chatId: Int?, messageId: Int?, inlineMessageId: String?, caption: String?, parseMode: String?, captionEntities: List<MessageEntity>, replyMarkup: InlineKeyboardMarkup?)

Request body for editMessageCaption

Parameters

chatId

Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

messageId

Required if inline_message_id is not specified. Identifier of the message to edit

inlineMessageId

Required if chat_id and message_id are not specified. Identifier of the inline message

caption

New caption of the message, 0-1024 characters after entities parsing

parseMode

Mode for parsing entities in the message caption. See formatting options for more details.

captionEntities

List of special entities that appear in the caption, which can be specified instead of parse_mode

replyMarkup

A JSON-serialized object for an inline keyboard.

Constructors

EditMessageCaptionRequest
Link copied to clipboard
common
fun EditMessageCaptionRequest(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), replyMarkup: InlineKeyboardMarkup? = null)
Required if inline_message_id is not specified.

Functions

component1
Link copied to clipboard
common
operator fun component1(): Int?
component2
Link copied to clipboard
common
operator fun component2(): Int?
component3
Link copied to clipboard
common
operator fun component3(): String?
component4
Link copied to clipboard
common
operator fun component4(): String?
component5
Link copied to clipboard
common
operator fun component5(): String?
component6
Link copied to clipboard
common
operator fun component6(): List<MessageEntity>
component7
Link copied to clipboard
common
operator fun component7(): InlineKeyboardMarkup?
copy
Link copied to clipboard
common
fun copy(chatId: Int? = null, messageId: Int? = null, inlineMessageId: String? = null, caption: String? = null, parseMode: String? = null, captionEntities: List<MessageEntity> = emptyList(), replyMarkup: InlineKeyboardMarkup? = null): EditMessageCaptionRequest
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

caption
Link copied to clipboard
common
val caption: String? = null
New caption of the message, 0-1024 characters after entities parsing
captionEntities
Link copied to clipboard
common
val captionEntities: List<MessageEntity>
List of special entities that appear in the caption, which can be specified instead of parse_mode
chatId
Link copied to clipboard
common
val chatId: Int? = null
Required if inline_message_id is not specified.
inlineMessageId
Link copied to clipboard
common
val inlineMessageId: String? = null
Required if chat_id and message_id are not specified.
messageId
Link copied to clipboard
common
val messageId: Int? = null
Required if inline_message_id is not specified.
parseMode
Link copied to clipboard
common
val parseMode: String? = null
Mode for parsing entities in the message caption.
replyMarkup
Link copied to clipboard
common
val replyMarkup: InlineKeyboardMarkup? = null
A JSON-serialized object for an inline keyboard.