com.antonioaltieri.telegram.botapi.types

Class Message

java.lang.Object

com.antonioaltieri.telegram.botapi.types.Message

public class Message
extends java.lang.Object

This object represents a message. Any getters labeled optional might return a default value (such as null).

See Also:

https://core.telegram.org/bots/api#message

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Type Defines the different types of Messages that can be received.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Methods

Modifier and Type	Method and Description
Audio	getAudio() Optional.
java.lang.String	getCaption() Optional.
Chat	getChat()
Contact	getContact() Optional.
int	getDate()
Document	getDocument() Optional.
int	getForwardDate() Optional.
User	getForwardFrom() Optional.
User	getFrom()
User	getLeftChatParticipant() Optional.
Location	getLocation() Optional.
int	getMessageId()
User	getNewChatParticipant() Optional.
java.util.List<PhotoSize>	getNewChatPhoto() Optional.
java.lang.String	getNewChatTitle() Optional.
java.util.List<PhotoSize>	getPhoto() Optional.
Message	getReplyToMessage() Optional.
Sticker	getSticker() Optional.
java.lang.String	getText() Optional.
Message.Type	getType() Returns the Message.Type of this Message.
Video	getVideo() Optional.
Voice	getVoice() Optional.
boolean	isDeleteChatPhoto() Optional.
boolean	isGroupChatCreated() Optional.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message()

Method Detail

getMessageId

public int getMessageId()

Returns:

Unique message identifier

getFrom

public User getFrom()

Returns:

Sender

getDate

public int getDate()

Returns:

Date the message was sent in Unix time

getChat

public Chat getChat()

Returns:

Conversation the message belongs to

getForwardFrom

public User getForwardFrom()

Optional.

Returns:

For forwarded messages, sender of the original message

getForwardDate

public int getForwardDate()

Optional.

Returns:

For forwarded messages, date the original message was sent in Unix time

getReplyToMessage

public Message getReplyToMessage()

Optional.

Returns:

For replies, the original message

getText

public java.lang.String getText()

Optional.

Returns:

For text messages, the actual UTF-8 text of the message

getAudio

public Audio getAudio()

Optional.

Returns:

Message is an audio file, information about the file

getVoice

public Voice getVoice()

Optional.

Returns:

Message is a voice file, information about the file

getDocument

public Document getDocument()

Optional.

Returns:

Message is a general file, information about the file

getPhoto

public java.util.List<PhotoSize> getPhoto()

Optional.

Returns:

Message is a photo, available sizes of the photo

getSticker

public Sticker getSticker()

Optional.

Returns:

Message is a sticker, information about the sticker

getVideo

public Video getVideo()

Optional.

Returns:

Message is a video, information about the video

getContact

public Contact getContact()

Optional.

Returns:

Message is a shared contact, information about the contact

getLocation

public Location getLocation()

Optional.

Returns:

Message is a shared location, information about the location

getNewChatParticipant

public User getNewChatParticipant()

Optional.

Returns:

A new member was added to the group, information about them (this member may be bot itself)

getLeftChatParticipant

public User getLeftChatParticipant()

Optional.

Returns:

A member was removed from the group, information about them (this member may be bot itself)

getNewChatTitle

public java.lang.String getNewChatTitle()

Optional.

Returns:

A group title was changed to this value

getNewChatPhoto

public java.util.List<PhotoSize> getNewChatPhoto()

Optional.

Returns:

A group photo was changed to this value

isDeleteChatPhoto

public boolean isDeleteChatPhoto()

Optional.

Returns:

Informs that the group photo was deleted

isGroupChatCreated

public boolean isGroupChatCreated()

Optional.

Returns:

Informs that the group has been created

getCaption

public java.lang.String getCaption()

Optional.

Returns:

Text description of the photo or the video

getType

public Message.Type getType()

Returns the Message.Type of this Message. This can be used to verify that a Message is the expected type. For example, call getType() == Message.Type.Document first before calling getDocument().

Returns:

The Type of this Message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object