Message

این شی نشان‌دهنده یک پیام است.

📝 اسکیمای داده

فیلد	نوع	توضیحات
message_id	int	شناسه منحصربه‌فرد پیام در داخل این گفتگو
from	User	اختیاری. کاربر ارسال‌کننده‌ی پیام. برای پیام‌هایی که در کانال ارسال می‌شوند، مقدار آن خالی است.
date	int	تاریخی که پیام ارسال شده است (در قالب زمان یونیکس)
chat	Chat	اطلاعات گفتگویی که پیام به آن تعلق دارد.
forward_from	User	اختیاری. برای پیام‌های باز ارسال شده که ارسال‌کننده‌ی پیام اصلی را نشان می‌دهد
forward_from_chat	Chat	اختیاری. برای پیام های باز ارسال شده که اطلاعات مربوط به گفتگوی اصلی پیام را نشان می‌دهد و در کانال‌ها, از طرف مدیران ناشناس است
forward_from_message_id	int	اختیاری. شناسه پیام اصلی در کانال، برای پیام‌های باز ارسال شده از کانال‌ها
forward_date	int	اختیاری. برای پیام های باز ارسال شده , تاریخی که پیام اصلی در آن زمان ارسال شده است (در قالب زمان یونیکس)
reply_to_message	Message	اختیاری. پیام اصلی که روی آن پاسخی داده شده است. توجه داشته باشید که حتی اگر خود شی Message در این فیلد، یک پاسخ به پیام باشد، این فیلد مقدار دهی نمی‌شود.
edite_date	int	اختیاری. تاریخ آخرین باری که پیام ویرایش شده است (در قالب زمان یونیکس)
text	string	اختیاری. متن واقعی پیام با فرمت UTF-8 برای پیام‌های متنی
animation	Animation	اختیاری برای پیام‌های که تصویر متحرک دارند این فیلد پر می شود و اطلاعاتی در مورد انیمیشن می‌دهد. برای سازگاری عقب‌رو، زمانی که این فیلد تنظیم شود، فیلد document نیز تنظیم خواهد شد.
audio	Audio	اختیاری. برای پیام‌هایی که به صورت فایل صوتی هستند این فیلد با اطلاعات فایل مقدار دهی می شود.
document	Document	اختیاری. برای پیام‌هایی که به صورت فایل عمومی هستند، اطلاعاتی در مورد فایل می‌دهد.
photo	Array of PhotoSize	اختیاری. برای پیام‌هایی که به صورت تصویر هستند، اندازه‌های موجود برای تصویر را می‌دهد.
sticker	Sticker	اختیاری. برای پیام‌هایی که به صورت استیکر هستند، اطلاعاتی در مورد استیکر می‌دهد.
video	Video	اختیاری. برای پیام‌هایی که به صورت ویدیو هستند، اطلاعاتی در مورد ویدیو می‌دهد.
voice	Voice	اختیاری. برای پیام‌های صوتی، اطلاعاتی در مورد فایل می‌دهد.
caption	string	اختیاری. توضیحات مربوط به انیمیشن، فایل صوتی، سند، تصویر، ویدیو یا پیام صوتی
contact	Contact	اختیاری. در صورتی که پیام یک مخاطب به اشتراک‌گذاشته‌شده باشد، اطلاعاتی در مورد مخاطب می‌دهد.
location	Location	اختیاری. اگر پیام یک موقعیت به اشتراک‌گذاشته‌شده باشد، اطلاعاتی در مورد این موقعیت می‌دهد.
new_chat_members	Array of User	اختیاری.اطلاعاتی در مورد اعضای جدیدی که به گروه اضافه شده‌اند می دهد (خود بازو می‌تواند یکی از این اعضا باشد)
left_chat_member	User	اختیاری. عضوی که از گروه حذف یا خارج شده است و اطلاعاتی در مورد آن (این عضو می‌تواند خود بازو باشد)
invoice	Invoice	اختیاری. در صورتی که پیام یک صورتحساب برای یک عملیات پرداخت باشد، اطلاعاتی در مورد صورتحساب می‌دهد.
successful_payment	SuccessfulPayment	اختیاری. در صورتی که پیام یک پرداخت موفق باشد ، اطلاعاتی در مورد پرداخت می‌دهد.
reply_markup	InlineKeyboardMarkup	اختیاری. صفحه‌کلید inline که به یک پیام پیوست شده است. کلیدهای login_url به عنوان کلیدهای url معمولی نشان داده می‌شوند.

⚙️ متد‌های دریافت

getMessageId()

شناسه منحصر به فرد پیام را بازیابی می‌کند.

$messageMessageId = $messageObject->getMessageId();

getFrom()

ارسال‌کننده پیام را بازیابی می‌کند.

$messageFrom = $messageObject->getFrom();

getDate()

تاریخ ارسال پیام را به صورت زمان یونیکس بازیابی می‌کند.

$messageDate = $messageObject->getDate();

getChat()

چت مربوط به پیام را بازیابی می‌کند.

$messageChat = $messageObject->getChat();

getForwardFrom()

ارسال‌کننده پیام اصلی را بازیابی می‌کند، اگر این پیام فوروارد شده باشد.

$messageForwardFrom = $messageObject->getForwardFrom();

getForwardFromChat()

کانال ارسال پیام اصلی را بازیابی می‌کند، اگر این پیام فوروارد شده باشد.

$messageForwardFromChat = $messageObject->getForwardFromChat();

getForwardFromMessageId()

شناسه پیام اصلی در کانال را بازیابی می‌کند، اگر پیام فوروارد شده باشد.

$messageForwardFromMessageId = $messageObject->getForwardFromMessageId();

getForwardDate()

زمان ارسال پیام اصلی را به صورت تایم‌استمپ یونیکس بازیابی می‌کند.

$messageForwardDate = $messageObject->getForwardDate();

getReplyToMessage()

پیام اصلی که این پیام به آن پاسخ داده است را بازیابی می‌کند.

$messageReplyTo = $messageObject->getReplyToMessage();

getEditDate()

آخرین زمان ویرایش پیام را به صورت تایم‌استمپ یونیکس بازیابی می‌کند.

$messageEditDate = $messageObject->getEditDate();

getText()

محتوای متنی پیام را بازیابی می‌کند، اگر موجود باشد.

$messageText = $messageObject->getText();

getAnimation()

جزئیات انیمیشن را بازیابی می‌کند، اگر پیام حاوی انیمیشن باشد.

$messageAnimation = $messageObject->getAnimation();

getAudio()

جزئیات صوت را بازیابی می‌کند، اگر پیام حاوی صوت باشد.

$messageAudio = $messageObject->getAudio();

getDocument()

جزئیات سند را بازیابی می‌کند، اگر پیام حاوی سند باشد.

$messageDocument = $messageObject->getDocument();

getPhoto()

آرایه اندازه‌های عکس را بازیابی می‌کند، اگر پیام حاوی عکس باشد.

$messagePhoto = $messageObject->getPhoto();

getSticker()

جزئیات استیکر را بازیابی می‌کند، اگر پیام حاوی استیکر باشد.

$messageSticker = $messageObject->getSticker();

getVideo()

جزئیات ویدیو را بازیابی می‌کند، اگر پیام حاوی ویدیو باشد.

$messageVideo = $messageObject->getVideo();

getVoice()

جزئیات پیام صوتی را بازیابی می‌کند، اگر پیام حاوی پیام صوتی باشد.

$messageVoice = $messageObject->getVoice();

getCaption()

زیرنویس رسانه را بازیابی می‌کند، اگر موجود باشد.

$messageCaption = $messageObject->getCaption();

getContact()

جزئیات مخاطب را بازیابی می‌کند، اگر پیام حاوی مخاطب باشد.

$messageContact = $messageObject->getContact();

getLocation()

جزئیات موقعیت مکانی را بازیابی می‌کند، اگر پیام حاوی موقعیت مکانی باشد.

$messageLocation = $messageObject->getLocation();

getNewChatMembers()

آرایه‌ای از اعضای جدید چت که به گروه یا سوپرگروه اضافه شده‌اند را بازیابی می‌کند.

$newChatMembers = $messageObject->getNewChatMembers();

getLeftChatMember()

جزئیات عضوی که از چت خارج شده یا از چت حذف شده است را بازیابی می‌کند.

$leftChatMember = $messageObject->getLeftChatMember();

getInvoice()

جزئیات فاکتور را بازیابی می‌کند، اگر پیام حاوی فاکتور باشد.

$messageInvoice = $messageObject->getInvoice();

getSuccessfulPayment()

جزئیات پیام پرداخت موفق را بازیابی می‌کند.

$successfulPayment = $messageObject->getSuccessfulPayment();

getReplyMarkup()

صفحه کلید اینلاین مربوط به پیام را بازیابی می‌کند، اگر موجود باشد.

$replyMarkup = $messageObject->getReplyMarkup();

➕ بیشتر

نکته

برای اطلاعات بیشتر، به مستندات رسمی بله مراجعه کنید.