pyrobale.objects.message¶

Classes¶

Message

This class represents a Message object in Telegram.

Module Contents¶

class pyrobale.objects.message.Message(message_id=None, from_user=None, date=None, chat=None, text=None, forward_from=None, forward_from_chat=None, forward_from_message_id=None, forward_date=None, edite_date=None, animation=None, audio=None, document=None, photo=None, sticker=None, video=None, voice=None, caption=None, contact=None, location=None, new_chat_members=None, left_chat_member=None, invoice=None, successful_payment=None, web_app_data=None, reply_markup=None, reply_to_message=None, client=None, **kwargs)[source]¶

This class represents a Message object in Telegram.

A message can contain various types of content like text, media, location, etc. It also provides methods to reply, edit, delete, and forward messages.

Parameters:

message_id (Optional[int])
from_user (Optional[pyrobale.objects.user.User])
date (Optional[int])
chat (Optional[pyrobale.objects.chat.Chat])
text (Optional[str])
forward_from (Optional[pyrobale.objects.user.User])
forward_from_chat (Optional[pyrobale.objects.chat.Chat])
forward_from_message_id (Optional[int])
forward_date (Optional[int])
edite_date (Optional[int])
animation (Optional[pyrobale.objects.animation.Animation])
audio (Optional[pyrobale.objects.audio.Audio])
document (Optional[pyrobale.objects.document.Document])
photo (Optional[list[pyrobale.objects.photosize.PhotoSize]])
sticker (Optional[pyrobale.objects.sticker.Sticker])
video (Optional[pyrobale.objects.video.Video])
voice (Optional[pyrobale.objects.voice.Voice])
caption (Optional[str])
contact (Optional[pyrobale.objects.contact.Contact])
location (Optional[pyrobale.objects.location.Location])
new_chat_members (Optional[list[pyrobale.objects.user.User]])
left_chat_member (Optional[pyrobale.objects.user.User])
invoice (Optional[pyrobale.objects.invoice.Invoice])
successful_payment (Optional[pyrobale.objects.successfulpayment.SuccessfulPayment])
web_app_data (Optional[pyrobale.objects.webappdata.WebAppData])
reply_markup (Optional[pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup])
reply_to_message (Optional[int])
client (Optional[pyrobale.client.Client])

id[source]¶

Unique message identifier

Type:: int

user[source]¶

Sender of the message

Type:: User

date[source]¶

Date the message was sent in Unix time

Type:: int

chat¶

Conversation the message belongs to

Type:: Chat

text[source]¶

Text content of the message

Type:: str

forward_from[source]¶

Original sender of a forwarded message

Type:: User

forward_from_chat[source]¶

Original chat of a forwarded message

Type:: Chat

forward_from_message_id[source]¶

Message ID in the original chat

Type:: int

forward_date[source]¶

Date when message was forwarded

Type:: int

edite_date[source]¶

Date when message was last edited

Type:: int

animation[source]¶

Message is an animation

Type:: Animation

audio[source]¶

Message is an audio file

Type:: Audio

document[source]¶

Message is a general file

Type:: Document

photo[source]¶

Message is a photo

Type:: list[PhotoSize]

sticker[source]¶

Message is a sticker

Type:: Sticker

video[source]¶

Message is a video

Type:: Video

voice[source]¶

Message is a voice message

Type:: Voice

caption[source]¶

Caption for media messages

Type:: str

contact[source]¶

Message is a shared contact

Type:: Contact

location[source]¶

Message is a shared location

Type:: Location

new_chat_members[source]¶

New members added to the chat

Type:: list[User]

left_chat_member[source]¶

Member removed from the chat

Type:: User

invoice[source]¶

Message is an invoice for payment

Type:: Invoice

successful_payment[source]¶

Message is a service message about successful payment

Type:: SuccessfulPayment

web_app_data[source]¶

Data from a Web App

Type:: WebAppData

reply_markup[source]¶

Inline keyboard attached to the message

Type:: InlineKeyboardMarkup

client[source]¶

Client instance associated with this message

Type:: Client

client: pyrobale.client.Client[source]¶

id: int = None[source]¶

user: pyrobale.objects.user.User = None[source]¶

date: int = None[source]¶

forward_from: pyrobale.objects.user.User | None = None[source]¶

forward_from_chat: pyrobale.objects.chat.Chat | None = None[source]¶

forward_from_message_id: int | None = None[source]¶

forward_date: int | None = None[source]¶

edite_date: int | None = None[source]¶

text: str | None = None[source]¶

animation: pyrobale.objects.animation.Animation | None = None[source]¶

audio: pyrobale.objects.audio.Audio | None = None[source]¶

document: pyrobale.objects.document.Document | None = None[source]¶

photo: list[pyrobale.objects.photosize.PhotoSize] | None = None[source]¶

sticker: pyrobale.objects.sticker.Sticker | None = None[source]¶

video: pyrobale.objects.video.Video | None = None[source]¶

voice: pyrobale.objects.voice.Voice | None = None[source]¶

caption: str | None = None[source]¶

contact: pyrobale.objects.contact.Contact | None = None[source]¶

location: pyrobale.objects.location.Location | None = None[source]¶

new_chat_members: list[pyrobale.objects.user.User] | None = None[source]¶

left_chat_member: pyrobale.objects.user.User | None = None[source]¶

invoice: pyrobale.objects.invoice.Invoice | None = None[source]¶

successful_payment: pyrobale.objects.successfulpayment.SuccessfulPayment | None = None[source]¶

web_app_data: pyrobale.objects.webappdata.WebAppData | None = None[source]¶

reply_markup: pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup | None = None[source]¶

property is_admin[source]¶

Check if the message sender is an admin in the chat.

Returns:: True if user is admin or creator, False otherwise
Return type:: bool

async reply(text, reply_markup=None)[source]¶

Reply to the current message with text.

Parameters:

text (str) – The text to send
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup for the message

Returns:

The sent message object

Return type:

Message

async edit(text, reply_markup=None)[source]¶

Edit the current message text.

Parameters:

text (str) – The new text
reply_markup (Optional[pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional new keyboard markup

Returns:

The edited message object

Return type:

Message

async delete()[source]¶

Delete the current message.

Returns:: True if successful
Return type:: bool

async forward(chat_id)[source]¶

Forward the current message to another chat.

Parameters:: chat_id (int) – Destination chat ID
Returns:: The forwarded message object
Return type:: Message

async reply_photo(photo, caption=None, reply_markup=None)[source]¶

Reply with a photo to the current message.

Parameters:

photo (str) – Photo to send (file_id or URL)
caption (Optional[str]) – Optional caption for the photo
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent photo message object

Return type:

Message

async reply_video(video, caption=None, reply_markup=None)[source]¶

Reply with a video to the current message.

Parameters:

video (str) – Video to send (file_id or URL)
caption (Optional[str]) – Optional caption for the video
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent video message object

Return type:

Message

async reply_audio(audio, caption=None, reply_markup=None)[source]¶

Reply with an audio file to the current message.

Parameters:

audio (str) – Audio to send (file_id or URL)
caption (Optional[str]) – Optional caption for the audio
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent audio message object

Return type:

Message

async reply_document(document, caption=None, reply_markup=None)[source]¶

Reply with a document to the current message.

Parameters:

document (str) – Document to send (file_id or URL)
caption (Optional[str]) – Optional caption for the document
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent document message object

Return type:

Message

async reply_sticker(sticker, reply_markup=None)[source]¶

Reply with a sticker to the current message.

Parameters:

sticker (str) – Sticker to send (file_id or URL)
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent sticker message object

Return type:

Message

async reply_location(latitude, longitude, horizontal_accuracy=None, reply_markup=None)[source]¶

Reply with a location to the current message.

Parameters:

latitude (float) – Latitude of the location
longitude (float) – Longitude of the location
horizontal_accuracy (Optional[float]) – The radius of uncertainty for the location
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent location message object

Return type:

Message

async reply_contact(phone_number, first_name, reply_markup=None)[source]¶

Reply with a contact to the current message.

Parameters:

phone_number (str) – Contact’s phone number
first_name (str) – Contact’s first name
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent contact message object

Return type:

Message

async reply_invoice(title, description, payload, provider_token, prices, reply_markup=None)[source]¶

Reply with an invoice to the current message.

Parameters:

title (str) – Product name
description (str) – Product description
payload (str) – Bot-defined invoice payload
provider_token (str) – Payment provider token
prices (list) – Price breakdown (amount in smallest units)
reply_markup (Union[pyrobale.objects.replykeyboardmarkup.ReplyKeyboardMarkup, pyrobale.objects.inlinekeyboardmarkup.InlineKeyboardMarkup]) – Optional keyboard markup

Returns:

The sent invoice message object

Return type:

Message