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

Document

این شی به طور کلی نشان‌دهنده یک فایل است (بر خلاف تصاویر، پیام‌های صوتی و فایل‌های صوتی).

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

فیلدنوعتوضیحات
file_idStringشناسه این فایل که می‌توان آن‌ را جهت دانلود یا استفاده مجدد از فایل به کار برد.
file_unique_idStringشناسه منحصربه‌فرد این فایل که فرض می‌شود، در طول زمان و برای بازوهای مختلف یکسان است. نمی‌توان این شناسه را برای دانلود یا استفاده مجدد از فایل به کار برد.
thumbnailPhotoSizeاختیاری. thumbnail سند که توسط ارسال‌کننده تعریف شده است.
file_nameStringاختیاری. نام اصلی فایل
mime_typeStringاختیاری. نوع MIME فایل
file_sizeIntegerاختیاری. حجم فایل با واحد بایت. می‌تواند بیشتر از ۲^۳۱ باشد و برخی زبان‌های برنامه‌نویسی ممکن است در تفسیر آن با مشکل روبه‌رو شوند. اما این فیلد حداکثر ۵۲ بیت با ارزش اهمیت دارد و فرمت ۶۴ بیتی علامت‌دار عدد صحیح یا عدد اعشاری ۶۴ بیتی برای ذخیره‌سازی آن مناسب است.

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

getFileId()

شناسه فایل را بازیابی می‌کند، که می‌توان از آن برای دانلود یا استفاده مجدد از فایل استفاده کرد.

$documentFileId = $documentObject->getFileId();

getFileUniqueId()

شناسه منحصر به فرد فایل را بازیابی می‌کند، که در طول زمان و در بین ربات‌های مختلف ثابت می‌ماند.

$documentFileUniqueId = $documentObject->getFileUniqueId();

getThumbnail()

تصویر بندانگشتی سند را به عنوان شیء PhotoSize بازیابی می‌کند، اگر موجود باشد.

$documentThumbnail = $documentObject->getThumbnail();

getFileName()

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

$documentFileName = $documentObject->getFileName();

getMimeType()

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

$documentMimeType = $documentObject->getMimeType();

getFileSize()

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

$documentFileSize = $documentObject->getFileSize();

➕ بیشتر

نکته

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