Message

Message

struct Message {}

Members

Aliases

id
alias id = message_id

Shorthand for message_id;

Functions

isNull
bool isNull()
Undocumented in source. Be warned that the author may not have intended to support it.

Properties

pinned_message
Message pinned_message [@property getter]
Message pinned_message [@property setter]

Specified message was pinned

reply_to_message
Message reply_to_message [@property getter]
Message reply_to_message [@property setter]

For replies, the original message

Variables

animation
Animation animation;

Message is an animation, information about the animation

audio
Audio audio;

Message is an audio file, information about the file

author_signature
string author_signature;

Signature of the post author for messages in channels

caption
string caption;

Caption for the audio, document, photo, video or voice

caption_entities
MessageEntity[] caption_entities;
Undocumented in source.
channel_chat_created
bool channel_chat_created;

Service message: the channel has been created

chat
Chat chat;

Conversation the message belongs to

connected_website
string connected_website;

The domain name of the website on which the user has logged in

contact
Contact contact;

Message is a shared contact, information about the contact

date
SysTime date;

Date the message was sent

delete_chat_photo
bool delete_chat_photo;

Service message: the chat photo was deleted

document
Document document;

Message is a general file, information about the file

edit_date
SysTime edit_date;

Date the message was last edited

entities
MessageEntity[] entities;

For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text

forward_date
SysTime forward_date;

For forwarded messages, date the original message was sent

forward_from
User forward_from;

For forwarded messages, sender of the original message

forward_from_chat
Chat forward_from_chat;

For messages forwarded from channels, information about the original channel

forward_from_message_id
int forward_from_message_id;

For messages forwarded from channels, identifier of the original message in the channel

forward_signature
string forward_signature;

For messages forwarded from channels, signature of the post author if present

from
User from;

Sender, empty for messages sent to channels

game
Game game;

Message is a game, information about the game

group_chat_created
bool group_chat_created;

Service message: the group has been created

invoice
Invoice invoice;

Message is an invoice for a payment, information about the invoice

left_chat_member
User left_chat_member;

A member was removed from the group, information about them

location
Location location;

Message is a shared location, information about the location

media_group_id
string media_group_id;

The unique identifier of a media message group this message belongs to

message_id
int message_id;

Unique message identifier inside this chat

migrate_from_chat_id
long migrate_from_chat_id;

The supergroup has been migrated from a group with the specified identifier

migrate_to_chat_id
long migrate_to_chat_id;

The group has been migrated to a supergroup with the specified identifier

new_chat_members
User[] new_chat_members;

New members that were added to the group or supergroup and information about them

new_chat_photo
PhotoSize[] new_chat_photo;

A chat photo was change to this value

new_chat_title
string new_chat_title;

A chat title was changed to this value

photo
PhotoSize[] photo;

Message is a photo, available sizes of the photo

sticker
Sticker sticker;

Message is a sticker, information about the sticker

successful_payment
SuccessfulPayment successful_payment;

Message is a service message about a successful payment, information about the payment

supergroup_chat_created
bool supergroup_chat_created;

Service message: the supergroup has been created

text
string text;

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

venue
Venue venue;

Message is a venue, information about the venue

video
Video video;

Message is a video, information about the video

video_note
VideoNote video_note;

Message is a video note, information about the video message

voice
Voice voice;

Message is a voice message, information about the file

See Also

Meta