Skip to content

feat(Message): create Message#getCommand method #1518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open

feat(Message): create Message#getCommand method #1518

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c27ce3a
Api Version 9.0
rubenlagus Jun 10, 2025
bdf6955
Merge branch 'master' into dev
rubenlagus Jun 12, 2025
ca6bd64
Merge branch 'master' into dev
rubenlagus Jun 15, 2025
d924e4b
feat(Message): create `Message#getCommand` method
yvasyliev Jun 20, 2025
1dba159
feat(Message): add `Message#entities` null check to the `Message#getC…
yvasyliev Jun 20, 2025
f3e469b
Merge branch 'dev' into feature/get-command
yvasyliev Jun 21, 2025
921fce1
doc(Message): return back @apiNote
yvasyliev Jun 27, 2025
51af81f
feat(Message): early return `null` command if no command found
yvasyliev Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 63 additions & 48 deletions ...ambots-meta/src/main/java/org/telegram/telegrambots/meta/api/objects/message/Message.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import lombok.ToString;
import lombok.experimental.SuperBuilder;
import lombok.extern.jackson.Jacksonized;
import org.apache.commons.lang3.math.NumberUtils;
import org.telegram.telegrambots.meta.api.objects.Audio;
import org.telegram.telegrambots.meta.api.objects.ChatShared;
import org.telegram.telegrambots.meta.api.objects.Contact;
Expand Down Expand Up @@ -68,10 +69,13 @@
import org.telegram.telegrambots.meta.api.objects.webapp.WebAppData;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Stream;

/**
* This object represents a message.
*
* @author Ruben Bermudez
* @version 1.0
*/
Expand Down Expand Up @@ -184,7 +188,8 @@ public class Message implements MaybeInaccessibleMessage {
private static final String PAID_STAR_COUNT_FIELD = "paid_star_count";

/**
* Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat),
* Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a
* big chat),
* the server might automatically schedule a message instead of sending it immediately.
* In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent
*/
Expand All @@ -200,7 +205,8 @@ public class Message implements MaybeInaccessibleMessage {
/**
* Optional.
* Sender of the message; may be empty for messages sent to channels.
* For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats
* For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user
* in non-channel chats
*/
@JsonProperty(FROM_FIELD)
private User from;
Expand All @@ -219,7 +225,7 @@ public class Message implements MaybeInaccessibleMessage {
* For forwarded messages, sender of the original message
*/
@JsonProperty(FORWARD_FROM_FIELD)
private User forwardFrom;
private User forwardFrom;
/**
* Optional.
* For messages forwarded from channels or from anonymous administrators, information about the original sender chat
Expand All @@ -237,7 +243,7 @@ public class Message implements MaybeInaccessibleMessage {
* For text messages, the actual UTF-8 text of the message
*/
@JsonProperty(TEXT_FIELD)
private String text;
private String text;
/**
* Optional.
* For text messages, special entities like usernames, URLs,
Expand Down Expand Up @@ -309,13 +315,15 @@ public class Message implements MaybeInaccessibleMessage {
private Animation animation;
/**
* Optional.
* Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
* Specified message was pinned. Note that the Message object in this field will not contain further
* reply_to_message fields even if it is itself a reply.
*/
@JsonProperty(PINNED_MESSAGE_FIELD)
private MaybeInaccessibleMessage pinnedMessage;
/**
* Optional.
* New members were added to the group or supergroup, information about them (the bot itself may be one of these members)
* New members were added to the group or supergroup, information about them (the bot itself may be one of these
* members)
*/
@JsonProperty(NEW_CHAT_MEMBERS_FIELD)
private List<User> newChatMembers;
Expand All @@ -324,13 +332,13 @@ public class Message implements MaybeInaccessibleMessage {
* A member was removed from the group, information about them (this member may be bot itself)
*/
@JsonProperty(LEFT_CHAT_MEMBER_FIELD)
private User leftChatMember;
private User leftChatMember;
/**
* Optional.
* A chat title was changed to this value
*/
@JsonProperty(NEW_CHAT_TITLE_FIELD)
private String newChatTitle;
private String newChatTitle;
/**
* Optional.
* A chat photo was change to this value
Expand All @@ -342,7 +350,7 @@ public class Message implements MaybeInaccessibleMessage {
* Informs that the chat photo was deleted
*/
@JsonProperty(DELETE_CHAT_PHOTO_FIELD)
private Boolean deleteChatPhoto;
private Boolean deleteChatPhoto;
/**
* Optional.
* Informs that the group has been created
Expand All @@ -352,7 +360,8 @@ public class Message implements MaybeInaccessibleMessage {
/**
* Optional.
* For replies in the same chat and message thread, the original message.
* Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
* Note that the Message object in this field will not contain further reply_to_message fields even if it itself
* is a reply.
*/
@JsonProperty(REPLY_TO_MESSAGE_FIELD)
private Message replyToMessage;
Expand All @@ -367,7 +376,7 @@ public class Message implements MaybeInaccessibleMessage {
* Caption for the document, photo or video, 0-200 characters
*/
@JsonProperty(CAPTION_FIELD)
private String caption;
private String caption;
/**
* Optional. Service message: the supergroup has been created.
* This field can‘t be received in a message coming through updates,
Expand All @@ -394,7 +403,7 @@ public class Message implements MaybeInaccessibleMessage {
* float type are safe for storing this identifier.
*/
@JsonProperty(MIGRATE_TO_CHAT_FIELD)
private Long migrateToChatId;
private Long migrateToChatId;
/**
* Optional. The supergroup has been migrated from a group with the specified identifier.
* This number may be greater than 32 bits and some programming languages
Expand All @@ -415,7 +424,7 @@ public class Message implements MaybeInaccessibleMessage {
* Message is a game, information about the game
*/
@JsonProperty(GAME_FIELD)
private Game game;
private Game game;
/**
* Optional.
* For forwarded channel posts, identifier of the original message in the channel
Expand All @@ -427,7 +436,7 @@ public class Message implements MaybeInaccessibleMessage {
* Message is an invoice for a payment, information about the invoice.
*/
@JsonProperty(INVOICE_FIELD)
private Invoice invoice;
private Invoice invoice;
/**
* Optional.
* Message is a service message about a successful payment, information about the payment.
Expand Down Expand Up @@ -457,22 +466,23 @@ public class Message implements MaybeInaccessibleMessage {
* The unique identifier of a media message group this message belongs to
*/
@JsonProperty(MEDIA_GROUP_ID_FIELD)
private String mediaGroupId;
private String mediaGroupId;
/**
* Optional.
* The domain name of the website on which the user has logged in
*/
@JsonProperty(CONNECTED_WEBSITE_FIELD)
private String connectedWebsite;
private String connectedWebsite;
/**
* Optional.
* Telegram Passport data
*/
@JsonProperty(PASSPORT_DATA_FIELD)
private PassportData passportData;
private PassportData passportData;
/**
* Optional.
* Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages.
* Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded
* messages.
*/
@JsonProperty(FORWARD_SENDER_NAME_FIELD)
private String forwardSenderName;
Expand All @@ -481,7 +491,7 @@ public class Message implements MaybeInaccessibleMessage {
* Message is a native poll, information about the poll
*/
@JsonProperty(POLL_FIELD)
private Poll poll;
private Poll poll;
/**
* Inline keyboard attached to the message.
*
Expand Down Expand Up @@ -541,7 +551,7 @@ public class Message implements MaybeInaccessibleMessage {
* Service message: data sent by a web app
*/
@JsonProperty(WEB_APP_DATA_FIELD)
private WebAppData webAppData;
private WebAppData webAppData;
/**
* Optional.
* Service message: video chat started
Expand All @@ -553,7 +563,7 @@ public class Message implements MaybeInaccessibleMessage {
* Service message: video chat ended
*/
@JsonProperty(VIDEO_CHAT_ENDED_FIELD)
private VideoChatEnded videoChatEnded;
private VideoChatEnded videoChatEnded;
/**
* Optional.
* Service message: new participants invited to a video chat
Expand Down Expand Up @@ -609,9 +619,10 @@ public class Message implements MaybeInaccessibleMessage {
@JsonProperty(GENERAL_FORUM_TOPIC_UNHIDDEN_FIELD)
private GeneralForumTopicUnhidden generalForumTopicUnhidden;
/**
* Optional.
* Service message: the user allowed the bot to write messages after adding it to the attachment or side menu,
* launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess
* Optional.
* Service message: the user allowed the bot to write messages after adding it to the attachment or side menu,
* launching a Web App from a link, or accepting an explicit request from a Web App sent by the method
* requestWriteAccess
*/
@JsonProperty(WRITE_ACCESS_ALLOWED_FIELD)
private WriteAccessAllowed writeAccessAllowed;
Expand Down Expand Up @@ -653,7 +664,8 @@ public class Message implements MaybeInaccessibleMessage {
private MessageOrigin forwardOrigin;
/**
* Optional.
* Options used for link preview generation for the message, if it is a text message and link preview options were changed
* Options used for link preview generation for the message, if it is a text message and link preview options
* were changed
*/
@JsonProperty(LINK_PREVIEW_OPTIONS_FIELD)
private LinkPreviewOptions linkPreviewOptions;
Expand Down Expand Up @@ -752,38 +764,38 @@ public class Message implements MaybeInaccessibleMessage {
@JsonProperty(SHOW_CAPTION_ABOVE_MEDIA_FIELD)
private Boolean showCaptionAboveMedia;
/**
* Optional.
* Message contains paid media; information about the paid media
* Optional.
* Message contains paid media; information about the paid media
*/
@JsonProperty(PAID_MEDIA_FIELD)
private PaidMediaInfo paidMedia;
/**
* Optional.
* Message is a service message about a refunded payment, information about the payment.
* Optional.
* Message is a service message about a refunded payment, information about the payment.
*/
@JsonProperty(REFUNDED_PAYMENT_FIELD)
private RefundedPayment refundedPayment;
/**
* Optional.
* Service message: a regular gift was sent or received
* Optional.
* Service message: a regular gift was sent or received
*/
@JsonProperty(GIFT_FIELD)
private GiftInfo gift;
/**
* Optional.
* Service message: a unique gift was sent or received
* Optional.
* Service message: a unique gift was sent or received
*/
@JsonProperty(UNIQUE_GIFT_FIELD)
private UniqueGiftInfo uniqueGift;
/**
* Optional.
* Service message: the price for paid messages has changed in the chat
* Optional.
* Service message: the price for paid messages has changed in the chat
*/
@JsonProperty(PAID_MESSAGE_PRICE_CHANGED_FIELD)
private PaidMessagePriceChanged paidMessagePriceChanged;
/**
* Optional.
* The number of Telegram Stars that were paid by the sender of the message to send it
* Optional.
* The number of Telegram Stars that were paid by the sender of the message to send it
*/
@JsonProperty(PAID_STAR_COUNT_FIELD)
private Integer paidStarCount;
Expand Down Expand Up @@ -853,15 +865,18 @@ public boolean hasText() {

@JsonIgnore
public boolean isCommand() {
if (hasText() && entities != null) {
for (MessageEntity entity : entities) {
if (entity != null && entity.getOffset() == 0 &&
EntityType.BOTCOMMAND.equals(entity.getType())) {
return true;
}
}
}
return false;
return getCommand() != null;
}

@JsonIgnore
public String getCommand() {
return Stream.ofNullable(entities)
.flatMap(Collection::stream)
.filter(entity -> entity != null && NumberUtils.INTEGER_ZERO.equals(entity.getOffset()))
Copy link
Owner

@rubenlagus rubenlagus Jul 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't think we need a whole new import to check a number vs 0

Copy link
Author

@yvasyliev yvasyliev Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's nothing wrong with importing constants. It's a bad practice to use magic numbers.

.findFirst()
.filter(entity -> EntityType.BOTCOMMAND.equals(entity.getType()))
.map(MessageEntity::getText)
.orElse(null);
}

@JsonIgnore
Expand All @@ -875,12 +890,12 @@ public boolean hasVideo() {
}

@JsonIgnore
public boolean hasAudio(){
public boolean hasAudio() {
return this.audio != null;
}

@JsonIgnore
public boolean hasVoice(){
public boolean hasVoice() {
return this.voice != null;
}

Expand Down