پرش به مطلب اصلی

InputMediaDocument

نشان‌دهنده یک فایل برای ارسال است.

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

فیلدنوعتوضیحات
typestringباید document باشد.
mediastringفایلی که باید ارسال شود و ۳ حالت میتواند داشته باشد. ۱)یک file_id را وارد کنید تا یک فایل که در سرورهای بله وجود دارد، ارسال شود (پیشنهادی)، ۲) یک HTTP URL وارد کنید تا آن یک فایل را از اینترنت دریافت شود ۳) یا عبارت “<attach://file_attach_name>” را وارد کنید تا یک فایل جدید را با استفاده از multipart/form-data با نام <file_attach_name> آپلود شود کنید.
thumbnailInputFile, stringاختیاری. thumbnail فایلی که ارسال شده است؛ اگر تولید thumbnail برای فایل در سمت سرور پشتیبانی شود، می‌توان آن را نادیده گرفت. تامبنیل باید با فرمت JPEG و حجم آن کمتر از ۲۰۰ کیلوبایت باشد. پهنا و ارتفاع تامبنیل نباید بیشتر از ۳۲۰ باشد. اگر فایل با استفاده از multipart/form-data آپلود نشده باشد، نادیده گرفته می‌شود. تامبنیل‌ها را نمی‌توان مجدداً استفاده کرد و آن‌ها را فقط می‌توان به صورت یک فایل جدید آپلود کرد، بنابراین اگر thumbnail با استفاده از multipart/form-data با نام <file_attach_name> آپلود شده باشد، می‌توانید عبارت “<attach://<file_attach_name>” را وارد کنید.
captionstringاختیاری. زیرنویس سندی که باید ارسال شود، بین ۰ تا ۱۰۲۴ کاراکتر

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

getType()

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

$type = $inputMediaDocumentObject->getType();

getMedia()

فایل رسانه‌ای (چه file_id، URL HTTP، یا ارجاع attach) که قرار است ارسال شود را بازیابی می‌کند.

$media = $inputMediaDocumentObject->getMedia();

getThumbnail()

تصویر بندانگشتی فایل سند را بازیابی می‌کند. این می‌تواند file_id، URL HTTP، یا ارجاع attach باشد اگر با استفاده از multipart/form-data بارگذاری شده باشد.

$thumbnail = $inputMediaDocumentObject->getThumbnail();

getCaption()

کپشن سندی که قرار است ارسال شود را بازیابی می‌کند. یک مقدار رشته‌ای (۰-۱۰۲۴ کاراکتر) را باز می‌گرداند.

$caption = $inputMediaDocumentObject->getCaption();

➕ بیشتر

نکته

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