Cleanup documentation

This commit is contained in:
Andrea Cavalli 2022-11-15 18:01:40 +01:00
parent 7d2abecd88
commit 75a65810d6
19 changed files with 402 additions and 109 deletions

View File

@ -57,23 +57,53 @@ public class SendAudio extends PartialBotApiMethod<Message> {
public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply"; public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
public static final String PROTECTCONTENT_FIELD = "protect_content"; public static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (or Username fro channels)
*/
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (or Username fro channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
private Integer messageThreadId; private Integer messageThreadId;
/**
* Audio file to send. file_id as String to resend an audio that is already on the Telegram servers or Url to upload it
*/
@NonNull @NonNull
private InputFile audio; ///< Audio file to send. file_id as String to resend an audio that is already on the Telegram servers or Url to upload it private InputFile audio;
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message /**
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. * Optional. If the message is a reply, ID of the original message
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard */
private String performer; ///< Optional. Performer of sent audio private Integer replyToMessageId;
private String title; ///< Optional. Title of sent audio /**
private String caption; ///< Optional. Audio caption (may also be used when resending documents by file_id), 0-200 characters * Optional. Sends the message silently. Users will receive a notification with no sound.
private String parseMode; ///< Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. */
private Integer duration; ///< Integer Duration of the audio in seconds as defined by sender private Boolean disableNotification;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
private ReplyKeyboard replyMarkup;
/**
* Optional. Performer of sent audio
*/
private String performer;
/**
* Optional. Title of sent audio
*/
private String title;
/**
* Optional. Audio caption (may also be used when resending documents by file_id), 0-200 characters
*/
private String caption;
/**
* Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
private String parseMode;
/**
* Integer Duration of the audio in seconds as defined by sender
*/
private Integer duration;
/** /**
* Optional. * Optional.
* Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. * Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size.
@ -83,10 +113,19 @@ public class SendAudio extends PartialBotApiMethod<Message> {
* attach://<file_attach_name> if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. * attach://<file_attach_name> if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
*/ */
private InputFile thumb; private InputFile thumb;
/**
* Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
*/
@Singular @Singular
private List<MessageEntity> captionEntities; ///< Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode private List<MessageEntity> captionEntities;
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found /**
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving * Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -44,35 +44,65 @@ public class SendContact extends BotApiMethodMessage {
private static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply"; private static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
private static final String PROTECTCONTENT_FIELD = "protect_content"; private static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@JsonProperty(CHATID_FIELD) @JsonProperty(CHATID_FIELD)
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
@JsonProperty(MESSAGETHREADID_FIELD) @JsonProperty(MESSAGETHREADID_FIELD)
private Integer messageThreadId; private Integer messageThreadId;
/**
* User's phone number
*/
@JsonProperty(PHONE_NUMBER_FIELD) @JsonProperty(PHONE_NUMBER_FIELD)
@NonNull @NonNull
private String phoneNumber; ///< User's phone number private String phoneNumber;
/**
* User's first name
*/
@JsonProperty(FIRST_NAME_FIELD) @JsonProperty(FIRST_NAME_FIELD)
@NonNull @NonNull
private String firstName; ///< User's first name private String firstName;
/**
* Optional. User's last name
*/
@JsonProperty(LAST_NAME_FIELD) @JsonProperty(LAST_NAME_FIELD)
private String lastName; ///< Optional. User's last name private String lastName;
/**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
@JsonProperty(DISABLENOTIFICATION_FIELD) @JsonProperty(DISABLENOTIFICATION_FIELD)
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
@JsonProperty(REPLYTOMESSAGEID_FIELD) @JsonProperty(REPLYTOMESSAGEID_FIELD)
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
@JsonProperty(REPLYMARKUP_FIELD) @JsonProperty(REPLYMARKUP_FIELD)
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private ReplyKeyboard replyMarkup;
/**
* Optional. Additional data about the contact in the form of a vCard
*/
@JsonProperty(VCARD_FIELD) @JsonProperty(VCARD_FIELD)
private String vCard; ///< Optional. Additional data about the contact in the form of a vCard private String vCard;
/**
* Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
@JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD) @JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD)
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
@JsonProperty(PROTECTCONTENT_FIELD) @JsonProperty(PROTECTCONTENT_FIELD)
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -71,16 +71,31 @@ public class SendDice extends BotApiMethodMessage {
*/ */
@JsonProperty(EMOJI_FIELD) @JsonProperty(EMOJI_FIELD)
private String emoji; private String emoji;
/**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
@JsonProperty(DISABLENOTIFICATION_FIELD) @JsonProperty(DISABLENOTIFICATION_FIELD)
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
@JsonProperty(REPLYTOMESSAGEID_FIELD) @JsonProperty(REPLYTOMESSAGEID_FIELD)
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
@JsonProperty(REPLYMARKUP_FIELD) @JsonProperty(REPLYMARKUP_FIELD)
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private ReplyKeyboard replyMarkup;
/**
* Optional. Pass True, if the message should be sent even if the specified replied-to message is not found
*/
@JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD) @JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD)
private Boolean allowSendingWithoutReply; ///< Optional. Pass True, if the message should be sent even if the specified replied-to message is not found private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
@JsonProperty(PROTECTCONTENT_FIELD) @JsonProperty(PROTECTCONTENT_FIELD)
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -51,20 +51,41 @@ public class SendDocument extends PartialBotApiMethod<Message> {
public static final String DISABLECONTENTTYPEDETECTION_FIELD = "disable_content_type_detection"; public static final String DISABLECONTENTTYPEDETECTION_FIELD = "disable_content_type_detection";
public static final String PROTECTCONTENT_FIELD = "protect_content"; public static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to or Username for the channel to send the message to
*/
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to or Username for the channel to send the message to private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
private Integer messageThreadId; private Integer messageThreadId;
/**
* File file to send. file_id as String to resend a file that is already on the Telegram servers or Url to upload it
*/
@NonNull @NonNull
private InputFile document; ///< File file to send. file_id as String to resend a file that is already on the Telegram servers or Url to upload it private InputFile document;
private String caption; ///< Optional. Document caption (may also be used when resending documents by file_id), 0-200 characters /**
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. * Optional. Document caption (may also be used when resending documents by file_id), 0-200 characters
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message */
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private String caption;
private String parseMode; ///< Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. /**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
private ReplyKeyboard replyMarkup;
/**
* Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
private String parseMode;
/** /**
* Optional. * Optional.
* Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. * Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size.
@ -74,11 +95,23 @@ public class SendDocument extends PartialBotApiMethod<Message> {
* if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. * if the thumbnail was uploaded using multipart/form-data under <file_attach_name>.
*/ */
private InputFile thumb; private InputFile thumb;
/**
* Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
*/
@Singular @Singular
private List<MessageEntity> captionEntities; ///< Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode private List<MessageEntity> captionEntities;
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found /**
private Boolean disableContentTypeDetection; ///< Optional Disables automatic server-side content type detection for files uploaded using multipart/form-data * Optional Pass True, if the message should be sent even if the specified replied-to message is not found
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving */
private Boolean allowSendingWithoutReply;
/**
* Optional Disables automatic server-side content type detection for files uploaded using multipart/form-data
*/
private Boolean disableContentTypeDetection;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -58,9 +58,12 @@ public class SendGame extends BotApiMethodMessage {
private static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply"; private static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
private static final String PROTECTCONTENT_FIELD = "protect_content"; private static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@JsonProperty(CHATID_FIELD) @JsonProperty(CHATID_FIELD)
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
@ -68,18 +71,36 @@ public class SendGame extends BotApiMethodMessage {
@JsonProperty(MESSAGETHREADID_FIELD) @JsonProperty(MESSAGETHREADID_FIELD)
private Integer messageThreadId; private Integer messageThreadId;
@JsonProperty(GAMESHORTNAME_FIELD) @JsonProperty(GAMESHORTNAME_FIELD)
/**
* Short name of the game
*/
@NonNull @NonNull
private String gameShortName; ///< Short name of the game private String gameShortName;
/**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
@JsonProperty(DISABLENOTIFICATION_FIELD) @JsonProperty(DISABLENOTIFICATION_FIELD)
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
@JsonProperty(REPLYTOMESSAGEID_FIELD) @JsonProperty(REPLYTOMESSAGEID_FIELD)
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
@JsonProperty(REPLYMARKUP_FIELD) @JsonProperty(REPLYMARKUP_FIELD)
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private ReplyKeyboard replyMarkup;
/**
* Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
@JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD) @JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD)
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
@JsonProperty(PROTECTCONTENT_FIELD) @JsonProperty(PROTECTCONTENT_FIELD)
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -46,9 +46,12 @@ public class SendLocation extends BotApiMethodMessage {
private static final String PROXIMITYALERTRADIUS_FIELD = "proximity_alert_radius"; private static final String PROXIMITYALERTRADIUS_FIELD = "proximity_alert_radius";
private static final String PROTECTCONTENT_FIELD = "protect_content"; private static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@JsonProperty(CHATID_FIELD) @JsonProperty(CHATID_FIELD)
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only

View File

@ -50,24 +50,54 @@ public class SendPhoto extends PartialBotApiMethod<Message> {
public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply"; public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
public static final String PROTECTCONTENT_FIELD = "protect_content"; public static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
private Integer messageThreadId; private Integer messageThreadId;
/**
* Photo to send. file_id as String to resend a photo that is already on the Telegram servers or URL to upload it
*/
@NonNull @NonNull
private InputFile photo; ///< Photo to send. file_id as String to resend a photo that is already on the Telegram servers or URL to upload it private InputFile photo;
private String caption; ///< Optional Photo caption (may also be used when resending photos by file_id). /**
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. * Optional Photo caption (may also be used when resending photos by file_id).
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message */
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private String caption;
private String parseMode; ///< Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. /**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
private Boolean disableNotification;
/**
* Optional. If the message is a reply, ID of the original message
*/
private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
private ReplyKeyboard replyMarkup;
/**
* Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
private String parseMode;
/**
* Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
*/
@Singular @Singular
private List<MessageEntity> captionEntities; ///< Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode private List<MessageEntity> captionEntities;
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found /**
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving * Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -48,45 +48,87 @@ public class SendVenue extends BotApiMethodMessage {
private static final String GOOGLEPLACETYPE_FIELD = "google_place_type"; private static final String GOOGLEPLACETYPE_FIELD = "google_place_type";
private static final String PROTECTCONTENT_FIELD = "protect_content"; private static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat to send the message to (Or username for channels)
*/
@JsonProperty(CHATID_FIELD) @JsonProperty(CHATID_FIELD)
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat to send the message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
@JsonProperty(MESSAGETHREADID_FIELD) @JsonProperty(MESSAGETHREADID_FIELD)
private Integer messageThreadId; private Integer messageThreadId;
/**
* Latitude of venue location
*/
@JsonProperty(LATITUDE_FIELD) @JsonProperty(LATITUDE_FIELD)
@NonNull @NonNull
private Double latitude; ///< Latitude of venue location private Double latitude;
/**
* Longitude of venue location
*/
@JsonProperty(LONGITUDE_FIELD) @JsonProperty(LONGITUDE_FIELD)
@NonNull @NonNull
private Double longitude; ///< Longitude of venue location private Double longitude;
/**
* Title of the venue
*/
@JsonProperty(TITLE_FIELD) @JsonProperty(TITLE_FIELD)
@NonNull @NonNull
private String title; ///< Title of the venue private String title;
/**
* Address of the venue
*/
@JsonProperty(ADDRESS_FIELD) @JsonProperty(ADDRESS_FIELD)
@NonNull @NonNull
private String address; ///< Address of the venue private String address;
/**
* Optional. Sends the message silently. Users will receive a notification with no sound.
*/
@JsonProperty(DISABLENOTIFICATION_FIELD) @JsonProperty(DISABLENOTIFICATION_FIELD)
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. private Boolean disableNotification;
/**
* Optional. Foursquare identifier of the venue
*/
@JsonProperty(FOURSQUAREID_FIELD) @JsonProperty(FOURSQUAREID_FIELD)
private String foursquareId; ///< Optional. Foursquare identifier of the venue private String foursquareId;
/**
* Optional. If the message is a reply, ID of the original message
*/
@JsonProperty(REPLYTOMESSAGEID_FIELD) @JsonProperty(REPLYTOMESSAGEID_FIELD)
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
@JsonProperty(REPLYMARKUP_FIELD) @JsonProperty(REPLYMARKUP_FIELD)
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard private ReplyKeyboard replyMarkup;
/**
* Optional. Foursquare type of the venue, if known.
*/
@JsonProperty(FOURSQUARETYPE_FIELD) @JsonProperty(FOURSQUARETYPE_FIELD)
private String foursquareType; ///< Optional. Foursquare type of the venue, if known. private String foursquareType;
/**
* Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
@JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD) @JsonProperty(ALLOWSENDINGWITHOUTREPLY_FIELD)
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found private Boolean allowSendingWithoutReply;
/**
* Optional. Google Places identifier of the venue
*/
@JsonProperty(GOOGLEPLACEID_FIELD) @JsonProperty(GOOGLEPLACEID_FIELD)
private String googlePlaceId; ///< Optional. Google Places identifier of the venue private String googlePlaceId;
/**
* Optional. Google Places type of the venue. (See supported types.)
*/
@JsonProperty(GOOGLEPLACETYPE_FIELD) @JsonProperty(GOOGLEPLACETYPE_FIELD)
private String googlePlaceType; ///< Optional. Google Places type of the venue. (See supported types.) private String googlePlaceType;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
@JsonProperty(PROTECTCONTENT_FIELD) @JsonProperty(PROTECTCONTENT_FIELD)
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -52,25 +52,58 @@ public class SendVoice extends PartialBotApiMethod<Message> {
public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply"; public static final String ALLOWSENDINGWITHOUTREPLY_FIELD = "allow_sending_without_reply";
public static final String PROTECTCONTENT_FIELD = "protect_content"; public static final String PROTECTCONTENT_FIELD = "protect_content";
/**
* Unique identifier for the chat sent message to (Or username for channels)
*/
@NonNull @NonNull
private String chatId; ///< Unique identifier for the chat sent message to (Or username for channels) private String chatId;
/** /**
* Unique identifier for the target message thread (topic) of the forum; * Unique identifier for the target message thread (topic) of the forum;
* for forum supergroups only * for forum supergroups only
*/ */
private Integer messageThreadId; private Integer messageThreadId;
/**
* Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.
*/
@NonNull @NonNull
private InputFile voice; ///< Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. private InputFile voice;
private Boolean disableNotification; ///< Optional. Sends the message silently. Users will receive a notification with no sound. /**
private Integer replyToMessageId; ///< Optional. If the message is a reply, ID of the original message * Optional. Sends the message silently. Users will receive a notification with no sound.
private ReplyKeyboard replyMarkup; ///< Optional. JSON-serialized object for a custom reply keyboard */
private Integer duration; ///< Optional. Duration of sent audio in seconds private Boolean disableNotification;
private String caption; ///< Optional. Voice caption (may also be used when resending videos by file_id). /**
private String parseMode; ///< Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. * Optional. If the message is a reply, ID of the original message
*/
private Integer replyToMessageId;
/**
* Optional. JSON-serialized object for a custom reply keyboard
*/
private ReplyKeyboard replyMarkup;
/**
* Optional. Duration of sent audio in seconds
*/
private Integer duration;
/**
* Optional. Voice caption (may also be used when resending videos by file_id).
*/
private String caption;
/**
* Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
private String parseMode;
/**
* Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
*/
@Singular @Singular
private List<MessageEntity> captionEntities; ///< Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode private List<MessageEntity> captionEntities;
private Boolean allowSendingWithoutReply; ///< Optional Pass True, if the message should be sent even if the specified replied-to message is not found /**
private Boolean protectContent; ///< Optional. Protects the contents of sent messages from forwarding and saving * Optional Pass True, if the message should be sent even if the specified replied-to message is not found
*/
private Boolean allowSendingWithoutReply;
/**
* Optional. Protects the contents of sent messages from forwarding and saving
*/
private Boolean protectContent;
@Tolerate @Tolerate
public void setChatId(@NonNull Long chatId) { public void setChatId(@NonNull Long chatId) {

View File

@ -246,20 +246,41 @@ public class Chat implements BotApiObject {
@JsonProperty(EMOJISTATUSCUSTOMEMOJIID_FIELD) @JsonProperty(EMOJISTATUSCUSTOMEMOJIID_FIELD)
private String emojiStatusCustomEmojiId; private String emojiStatusCustomEmojiId;
/**
* Optional. Extra.
*/
@JsonProperty(IS_VERIFIED_FIELD) @JsonProperty(IS_VERIFIED_FIELD)
private Boolean isVerified; ///< Optional. Extra. private Boolean isVerified;
/**
* Optional. Extra.
*/
@JsonProperty(IS_PREMIUM_FIELD) @JsonProperty(IS_PREMIUM_FIELD)
private Boolean isPremium; ///< Optional. Extra. private Boolean isPremium;
/**
* Optional. Extra.
*/
@JsonProperty(IS_SUPPORT_FIELD) @JsonProperty(IS_SUPPORT_FIELD)
private Boolean isSupport; ///< Optional. Extra. private Boolean isSupport;
/**
* Optional. Extra.
*/
@JsonProperty(IS_CREATOR_FIELD) @JsonProperty(IS_CREATOR_FIELD)
private Boolean isCreator; ///< Optional. Extra. private Boolean isCreator;
/**
* Optional. Extra.
*/
@JsonProperty(IS_SCAM_FIELD) @JsonProperty(IS_SCAM_FIELD)
private Boolean isScam; ///< Optional. Extra. private Boolean isScam;
/**
* Optional. Extra.
*/
@JsonProperty(IS_FAKE_FIELD) @JsonProperty(IS_FAKE_FIELD)
private Boolean isFake; ///< Optional. Extra. private Boolean isFake;
/**
* Optional. Extra.
*/
@JsonProperty(DC_ID_FIELD) @JsonProperty(DC_ID_FIELD)
private Integer dcId; ///< Optional. Extra. private Integer dcId;
@JsonIgnore @JsonIgnore
public Boolean isGroupChat() { public Boolean isGroupChat() {

View File

@ -48,17 +48,23 @@ public class LoginUrl implements Validable, BotApiObject {
@JsonProperty(URL_FIELD) @JsonProperty(URL_FIELD)
@NonNull @NonNull
private String url; private String url;
/**
* Optional. New text of the button in forwarded messages.
*/
@JsonProperty(FORWARD_TEXT_FIELD) @JsonProperty(FORWARD_TEXT_FIELD)
private String forwardText; ///< Optional. New text of the button in forwarded messages. private String forwardText;
/** /**
* Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. * Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details.
* If not specified, the current bot's username will be assumed. * If not specified, the current bot's username will be assumed.
* The url's domain must be the same as the domain linked with the bot. * The url's domain must be the same as the domain linked with the bot.
*/ */
@JsonProperty(BOT_USERNAME_FIELD) @JsonProperty(BOT_USERNAME_FIELD)
private String botUsername; ///< Optional. Animation duration private String botUsername;
/**
* Optional. Pass True to request the permission for your bot to send messages to the user.
*/
@JsonProperty(REQUEST_WRITE_ACCESS_FIELD) @JsonProperty(REQUEST_WRITE_ACCESS_FIELD)
private Boolean requestWriteAccess; ///< Optional. Pass True to request the permission for your bot to send messages to the user. private Boolean requestWriteAccess;
@Override @Override
public void validate() throws TelegramApiValidationException { public void validate() throws TelegramApiValidationException {

View File

@ -109,7 +109,7 @@ public class MessageEntity implements BotApiObject {
*/ */
@Setter(AccessLevel.NONE) @Setter(AccessLevel.NONE)
@JsonIgnore @JsonIgnore
private MemoizedUTF16Substring text; ///< Text present in the entity. Computed from offset and length private MemoizedUTF16Substring text;
public String getText() { public String getText() {
if (text == null) { if (text == null) {

View File

@ -62,8 +62,10 @@ public class PhotoSize implements BotApiObject {
* Undocumented field. Optional. Can contain the path to download the file directly without calling to getFile * Undocumented field. Optional. Can contain the path to download the file directly without calling to getFile
*/ */
@JsonProperty(FILEPATH_FIELD) @JsonProperty(FILEPATH_FIELD)
private String filePath; ///< Undocumented field. Optional. Can contain the path to download the file directly without calling to getFile private String filePath;
/**
* Extra. Optional.
*/
@JsonProperty(DATE_FIELD) @JsonProperty(DATE_FIELD)
private Integer date; ///< Extra. Optional. private Integer date;
} }

View File

@ -108,11 +108,19 @@ public class Update implements BotApiObject {
* New poll state. Bots receive only updates about polls, which are sent by the bot. * New poll state. Bots receive only updates about polls, which are sent by the bot.
*/ */
@JsonProperty(POLL_FIELD) @JsonProperty(POLL_FIELD)
private Poll poll; ///< Optional. New poll state. Bots receive only updates about polls, which are sent by the bot. private Poll poll;
/**
* Optional.
* Extra.
*/
@JsonProperty(EXTRA_SUPER_CHAT_INFO_FIELD) @JsonProperty(EXTRA_SUPER_CHAT_INFO_FIELD)
private ExtraChatInfo extraSuperChatInfo; ///< Optional. Extra. private ExtraChatInfo extraSuperChatInfo;
/**
* Optional.
* Extra.
*/
@JsonProperty(EXTRA_BASIC_CHAT_INFO_FIELD) @JsonProperty(EXTRA_BASIC_CHAT_INFO_FIELD)
private ExtraChatInfo extraBasicChatInfo; ///< Optional. Extra. private ExtraChatInfo extraBasicChatInfo;
/** /**
* Optional. * Optional.
* A user changed their answer in a non-anonymous poll. * A user changed their answer in a non-anonymous poll.

View File

@ -65,22 +65,26 @@ public class InputVenueMessageContent implements InputMessageContent {
@NonNull @NonNull
private String address; private String address;
/** /**
* Optional. Foursquare identifier of the venue, if known * Optional.
* Foursquare identifier of the venue, if known
*/ */
@JsonProperty(FOURSQUAREID_FIELD) @JsonProperty(FOURSQUAREID_FIELD)
private String foursquareId; private String foursquareId;
/** /**
* Optional. Foursquare type of the venue, if known. * Optional.
* Foursquare type of the venue, if known.
*/ */
@JsonProperty(FOURSQUARETYPE_FIELD) @JsonProperty(FOURSQUARETYPE_FIELD)
private String foursquareType; private String foursquareType;
/** /**
* Optional. Google Places identifier of the venue * Optional.
* Google Places identifier of the venue
*/ */
@JsonProperty(GOOGLEPLACEID_FIELD) @JsonProperty(GOOGLEPLACEID_FIELD)
private String googlePlaceId; private String googlePlaceId;
/** /**
* Optional. Google Places type of the venue. (See supported types.) * Optional.
* Google Places type of the venue. (See supported types.)
*/ */
@JsonProperty(GOOGLEPLACETYPE_FIELD) @JsonProperty(GOOGLEPLACETYPE_FIELD)
private String googlePlaceType; private String googlePlaceType;

View File

@ -49,7 +49,8 @@ public class ReplyKeyboardMarkup implements ReplyKeyboard {
@JsonProperty(ONETIMEKEYBOARD_FIELD) @JsonProperty(ONETIMEKEYBOARD_FIELD)
private Boolean oneTimeKeyboard; ///< Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false. private Boolean oneTimeKeyboard; ///< Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false.
/** /**
* Optional. Use this parameter if you want to show the keyboard to specific users only. * Optional.
* Use this parameter if you want to show the keyboard to specific users only.
* Targets: * Targets:
* 1) users that are @mentioned in the text of the Message object; * 1) users that are @mentioned in the text of the Message object;
* 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. * 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.

View File

@ -38,7 +38,8 @@ public class ReplyKeyboardRemove implements ReplyKeyboard {
@NonNull @NonNull
private Boolean removeKeyboard; ///< Requests clients to remove the custom keyboard private Boolean removeKeyboard; ///< Requests clients to remove the custom keyboard
/** /**
* Optional. Use this parameter if you want to show the keyboard to specific users only. * Optional.
* Use this parameter if you want to show the keyboard to specific users only.
* Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's * Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's
* message is a reply (has reply_to_message_id), sender of the original message. * message is a reply (has reply_to_message_id), sender of the original message.
*/ */

View File

@ -59,7 +59,8 @@ public class InlineKeyboardButton implements Validable, BotApiObject {
@JsonProperty(CALLBACK_DATA_FIELD) @JsonProperty(CALLBACK_DATA_FIELD)
private String callbackData; ///< Optional. Data to be sent in a callback query to the bot when button is pressed private String callbackData; ///< Optional. Data to be sent in a callback query to the bot when button is pressed
/** /**
* Optional. Description of the game that will be launched when the user presses the button. * Optional.
* Description of the game that will be launched when the user presses the button.
* *
* @apiNote This type of button must always be the first button in the first row. * @apiNote This type of button must always be the first button in the first row.
*/ */
@ -79,7 +80,8 @@ public class InlineKeyboardButton implements Validable, BotApiObject {
@JsonProperty(SWITCH_INLINE_QUERY_FIELD) @JsonProperty(SWITCH_INLINE_QUERY_FIELD)
private String switchInlineQuery; private String switchInlineQuery;
/** /**
* Optional. If set, pressing the button will insert the bots username and the specified * Optional.
* If set, pressing the button will insert the bots username and the specified
* inline query in the current chat's input field. Can be empty, * inline query in the current chat's input field. Can be empty,
* in which case only the bots username will be inserted. * in which case only the bots username will be inserted.
*/ */
@ -87,7 +89,8 @@ public class InlineKeyboardButton implements Validable, BotApiObject {
private String switchInlineQueryCurrentChat; private String switchInlineQueryCurrentChat;
/** /**
* Optional. Specify True, to send a Buy button. * Optional.
* Specify True, to send a Buy button.
* *
* @apiNote This type of button must always be the first button in the first row. * @apiNote This type of button must always be the first button in the first row.
*/ */

View File

@ -72,7 +72,8 @@ public class KeyboardButton implements Validable, BotApiObject {
private KeyboardButtonPollType requestPoll; private KeyboardButtonPollType requestPoll;
/** /**
* Optional. Description of the web app that will be launched when the user presses the button. * Optional.
* Description of the web app that will be launched when the user presses the button.
* The web app will be able to send a web_app_data service message. * The web app will be able to send a web_app_data service message.
* Available in private chats only. * Available in private chats only.
*/ */