All Downloads are FREE. Search and download functionalities are using the official Maven repository.

Explore the source code of the class Message.java

package com.antonioaltieri.telegram.botapi.types;

import com.google.gson.annotations.SerializedName;

import java.util.List;

/**
 * This object represents a message.
 *
 * Any getters labeled optional might return a default value (such as [email protected] null}).
 *
 * @see https://core.telegram.org/bots/api#message
 */
public class Message {

    @SerializedName("message_id")
    private int messageId;

    @SerializedName("from")
    private User from;

    @SerializedName("date")
    private int date;

    @SerializedName("chat")
    private Chat chat;

    @SerializedName("forward_from")
    private User forwardFrom;

    @SerializedName("forward_date")
    private int forwardDate;

    @SerializedName("reply_to_message")
    private com.antonioaltieri.telegram.botapi.types.Message replyToMessage;

    @SerializedName("text")
    private String text;

    @SerializedName("audio")
    private Audio audio;

    @SerializedName("voice")
    private Voice voice;

    @SerializedName("document")
    private Document document;

    @SerializedName("photo")
    private List photo;

    @SerializedName("sticker")
    private Sticker sticker;

    @SerializedName("video")
    private Video video;

    @SerializedName("contact")
    private Contact contact;

    @SerializedName("location")
    private Location location;

    @SerializedName("new_chat_participant")
    private User newChatParticipant;

    @SerializedName("left_chat_participant")
    private User leftChatParticipant;

    @SerializedName("new_chat_title")
    private String newChatTitle;

    @SerializedName("new_chat_photo")
    private List newChatPhoto;

    @SerializedName("delete_chat_photo")
    private boolean deleteChatPhoto;

    @SerializedName("group_chat_created")
    private boolean groupChatCreated;

    @SerializedName("super_group_chat_created")
    private boolean superGroupChatCreated;

    @SerializedName("channel_chat_created")
    private boolean channelChatCreated;

    @SerializedName("migrate_to_chat_id")
    private boolean migrateToChatID;

    @SerializedName("migrate_from_chat_id")
    private boolean migrateFromChatID;

    @SerializedName("caption")
    private String caption;

    private Type type;

    /**
     * @return Unique message identifier
     */
    public int getMessageId() {
        return messageId;
    }

    /**
     * @return Sender
     */
    public User getFrom() {
        return from;
    }

    /**
     * @return Date the message was sent in Unix time
     */
    public int getDate() {
        return date;
    }

    /**
     * @return Conversation the message belongs to
     */
    public Chat getChat() {
        return chat;
    }

    /**
     * Optional.
     *
     * @return For forwarded messages, sender of the original message
     */
    public User getForwardFrom() {
        return forwardFrom;
    }

    /**
     * Optional.
     *
     * @return For forwarded messages, date the original message was sent in Unix time
     */
    public int getForwardDate() {
        return forwardDate;
    }

    /**
     * Optional.
     *
     * @return For replies, the original message
     */
    public com.antonioaltieri.telegram.botapi.types.Message getReplyToMessage() {
        return replyToMessage;
    }

    /**
     * Optional.
     *
     * @return For text messages, the actual UTF-8 text of the message
     */
    public String getText() {
        return text;
    }

    /**
     * Optional.
     *
     * @return Message is an audio file, information about the file
     */
    public Audio getAudio() {
        return audio;
    }

    /**
     * Optional.
     *
     * @return Message is a voice file, information about the file
     */
    public Voice getVoice() {
        return voice;
    }
    /**
     * Optional.
     *
     * @return Message is a general file, information about the file
     */
    public Document getDocument() {
        return document;
    }

    /**
     * Optional.
     *
     * @return Message is a photo, available sizes of the photo
     */
    public List getPhoto() {
        return photo;
    }

    /**
     * Optional.
     *
     * @return Message is a sticker, information about the sticker
     */
    public Sticker getSticker() {
        return sticker;
    }

    /**
     * Optional.
     *
     * @return Message is a video, information about the video
     */
    public Video getVideo() {
        return video;
    }

    /**
     * Optional.
     *
     * @return Message is a shared contact, information about the contact
     */
    public Contact getContact() {
        return contact;
    }

    /**
     * Optional.
     *
     * @return Message is a shared location, information about the location
     */
    public Location getLocation() {
        return location;
    }

    /**
     * Optional.
     *
     * @return A new member was added to the group, information about them (this member may be bot itself)
     */
    public User getNewChatParticipant() {
        return newChatParticipant;
    }

    /**
     * Optional.
     *
     * @return A member was removed from the group, information about them (this member may be bot itself)
     */
    public User getLeftChatParticipant() {
        return leftChatParticipant;
    }

    /**
     * Optional.
     *
     * @return A group title was changed to this value
     */
    public String getNewChatTitle() {
        return newChatTitle;
    }

    /**
     * Optional.
     *
     * @return A group photo was changed to this value
     */
    public List getNewChatPhoto() {
        return newChatPhoto;
    }

    /**
     * Optional.
     *
     * @return Informs that the group photo was deleted
     */
    public boolean isDeleteChatPhoto() {
        return deleteChatPhoto;
    }

    /**
     * Optional.
     *
     * @return Informs that the group has been created
     */
    public boolean isGroupChatCreated() {
        return groupChatCreated;
    }

    /**
     * Optional.
     *
     * @return Text description of the photo or the video
     */
    public String getCaption() {
        return caption;
    }

    /**
     * Returns the [email protected] com.antonioaltieri.telegram.botapi.types.Message.Type} of this Message.
     *
     * This can be used to verify that a Message is the expected type.
     * For example, call [email protected] getType() == Message.Type.Document} first before calling [email protected] com.antonioaltieri.telegram.botapi.types.Message#getDocument()}.
     *
     * @return The [email protected] Type} of this [email protected] Message}
     */
    public Type getType() {
        if (type == null)
            determineType();
        return type;
    }

    private void determineType() {
        if (text != null)
            type = Type.TEXT;

        else if (audio != null)
            type = Type.AUDIO;

        else if (voice != null)
            type = Type.VOICE;

        else if (document != null)
            type = Type.DOCUMENT;

        else if (photo != null)
            type = Type.PHOTO;

        else if (sticker != null)
            type = Type.STICKER;

        else if (video != null)
            type = Type.VIDEO;

        else if (contact != null)
            type = Type.CONTACT;

        else if (location != null)
            type = Type.LOCATION;

        else if (newChatParticipant != null)
            type = Type.NEW_CHAT_PARTICIPANT;

        else if (leftChatParticipant != null)
            type = Type.LEFT_CHAT_PARTICIPANT;

        else if (newChatPhoto != null)
            type = Type.NEW_CHAT_PHOTO;

        else if (deleteChatPhoto)
            type = Type.DELETE_CHAT_PHOTO;

        else if (groupChatCreated)
            type = Type.GROUP_CHAT_CREATED;

        else
            type = Type.UNKNOWN;
    }

    @Override
    public String toString() {
        String sb = "Message{";
        sb=sb+"type="+type;
        sb=sb+", messageId="+messageId;
        sb=sb+", from="+from;
        sb=sb+", date="+date;
        sb=sb+", chat="+chat;
        sb=sb+'}';
        return sb;
    }

    /**
     * Defines the different types of Messages that can be received.
     */
    public enum Type {
        TEXT,
        DOCUMENT,
        AUDIO,
        VOICE,
        PHOTO,
        STICKER,
        VIDEO,
        CONTACT,
        LOCATION,
        NEW_CHAT_PARTICIPANT,
        LEFT_CHAT_PARTICIPANT,
        NEW_CHAT_PHOTO,
        DELETE_CHAT_PHOTO,
        GROUP_CHAT_CREATED,
        UNKNOWN
    }
}