simbot-component-telegram-api/love.forte.simbot.telegram.api.message/SendPhotoApi/Body

Body

class Body(source)

The request body for SendPhotoApi

Constructors

constructor()

Properties

businessConnectionId

@SerialName(value = "business_connection_id")

var businessConnectionId: String?

Optional. Unique identifier of the business connection on behalf of which the message will be sent

var caption: String?

Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing

captionEntities

@SerialName(value = "caption_entities")

var captionEntities: MutableCollection<MessageEntity>?

Optional. A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

@SerialName(value = "chat_id")

lateinit var chatId: ChatId

Required unique identifier for the target chat or username of the target channel (in the format @channelusername)

disableNotification

@SerialName(value = "disable_notification")

var disableNotification: Boolean?

Optional. Sends the message silently. Users will receive a notification with no sound.

@SerialName(value = "has_spoiler")

var hasSpoiler: Boolean?

Optional. Pass True if the photo needs to be covered with a spoiler animation

messageThreadId

@SerialName(value = "message_thread_id")

var messageThreadId: Int?

Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

@SerialName(value = "parse_mode")

var parseMode: String?

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

lateinit var photo: InputFile

Required. Photo to send. (See the documentation).

@SerialName(value = "protect_content")

var protectContent: Boolean?

Optional. Protects the contents of the sent message from forwarding and saving

@SerialName(value = "reply_markup")

var replyMarkup: ReplyMarkupWrapper?

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user. Not supported for messages sent on behalf of a business account

replyParameters

@SerialName(value = "reply_parameters")

var replyParameters: ReplyParameters?

Optional. Description of the message to reply to

Functions

addCaptionEntity

fun addCaptionEntity(captionEntity: MessageEntity)

Add a captionEntity into captionEntities.