Class TdApi.EditMessageCaption
java.lang.Object
dev.voroby.springframework.telegram.client.TdApi.Object
dev.voroby.springframework.telegram.client.TdApi.Function<TdApi.Message>
dev.voroby.springframework.telegram.client.TdApi.EditMessageCaption
- Enclosing class:
- TdApi
Edits the message content caption. Returns the edited message after the edit is completed on the server side.
Returns Message
-
Field Summary
Modifier and TypeFieldDescriptionNew message content caption; 0-getOption("message_caption_length_max") characters; pass null to remove caption.long
The chat the message belongs to.static final int
Identifier uniquely determining type of the object.long
Identifier of the message.The new message reply markup; pass null if none; for bots only.boolean
Pass true to show the caption above the media; otherwise, the caption will be shown below the media. -
Constructor Summary
ConstructorDescriptionDefault constructor for a function, which edits the message content caption.EditMessageCaption
(long chatId, long messageId, TdApi.ReplyMarkup replyMarkup, TdApi.FormattedText caption, boolean showCaptionAboveMedia) Creates a function, which edits the message content caption. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns an identifier uniquely determining type of the object.Methods inherited from class dev.voroby.springframework.telegram.client.TdApi.Function
toString
-
Field Details
-
chatId
public long chatIdThe chat the message belongs to. -
messageId
public long messageIdIdentifier of the message. Use messageProperties.canBeEdited to check whether the message can be edited. -
replyMarkup
The new message reply markup; pass null if none; for bots only. -
showCaptionAboveMedia
public boolean showCaptionAboveMediaPass true to show the caption above the media; otherwise, the caption will be shown below the media. Can be true only for animation, photo, and video messages. -
CONSTRUCTOR
public static final int CONSTRUCTORIdentifier uniquely determining type of the object.- See Also:
-
-
Constructor Details
-
EditMessageCaption
public EditMessageCaption()Default constructor for a function, which edits the message content caption. Returns the edited message after the edit is completed on the server side.Returns
Message
-
EditMessageCaption
public EditMessageCaption(long chatId, long messageId, TdApi.ReplyMarkup replyMarkup, TdApi.FormattedText caption, boolean showCaptionAboveMedia) Creates a function, which edits the message content caption. Returns the edited message after the edit is completed on the server side.Returns
Message
- Parameters:
chatId
- The chat the message belongs to.messageId
- Identifier of the message. Use messageProperties.canBeEdited to check whether the message can be edited.replyMarkup
- The new message reply markup; pass null if none; for bots only.caption
- New message content caption; 0-getOption("message_caption_length_max") characters; pass null to remove caption.showCaptionAboveMedia
- Pass true to show the caption above the media; otherwise, the caption will be shown below the media. Can be true only for animation, photo, and video messages.
-
-
Method Details
-
getConstructor
public int getConstructor()Description copied from class:TdApi.Object
Returns an identifier uniquely determining type of the object.- Specified by:
getConstructor
in classTdApi.Object
- Returns:
- this.CONSTRUCTOR
-