chrome.downloads

توضیحات

از API مربوط به chrome.downloads برای شروع، نظارت، دستکاری و جستجوی دانلودها به صورت برنامه‌نویسی شده استفاده کنید.

مجوزها

downloads

برای استفاده از این API، باید مجوز "downloads" را در مانیفست افزونه اعلام کنید.

{
  "name": "My extension",
  ...
  "permissions": [
    "downloads"
  ],
}

مثال‌ها

می‌توانید مثال‌های ساده‌ای از استفاده از API مربوط به chrome.downloads را در دایرکتوری examples/api/downloads بیابید. برای مثال‌های دیگر و کمک در مشاهده کد منبع، به Samples مراجعه کنید.

انواع

BooleanDelta

خواص

  • فعلی

    بولی اختیاری

  • قبلی

    بولی اختیاری

DangerType

شمارشی

«پرونده»
نام فایل دانلود شده مشکوک است.

"آدرس اینترنتی"
آدرس اینترنتی (URL) دانلود، مخرب شناخته شده است.

«محتوا»
فایل دانلود شده به عنوان فایل مخرب شناخته می‌شود.

"غیرمعمول"
آدرس اینترنتی دانلود معمولاً دانلود نمی‌شود و می‌تواند خطرناک باشد.

"میزبان"
این دانلود از میزبانی انجام شده که به توزیع فایل‌های باینری مخرب معروف است و احتمالاً خطرناک است.

"ناخواسته"
دانلود به طور بالقوه ناخواسته یا ناامن است. برای مثال، می‌تواند تغییراتی در تنظیمات مرورگر یا رایانه ایجاد کند.

"امن"
این دانلود هیچ خطر شناخته‌شده‌ای برای رایانه کاربر ندارد.

"پذیرفته شده"
کاربر دانلود خطرناک را پذیرفته است.

"مجاز بودن توسط سیاست"
ارزش‌های مرتبط با سازمان

"اسکن ناهمزمان"

"اسکن رمز عبور محلی ناهمگام"

"با رمز عبور محافظت می‌شود"

"مسدود شده خیلی بزرگ"

«هشدار محتوای حساس»

"بلوک محتوای حساس"

"اسکن عمیق ناموفق"

"اسکن عمیق امن"

"اسکن عمیق باز شده خطرناک"

"درخواست برای اسکن"

"درخواست برای اسکن رمز عبور محلی"

"به خطر افتادن حساب"

"اسکن مسدود شده ناموفق بود"

"ذخیره اجباری برای جی‌درایو"
برای استفاده توسط افزونه مرورگر امن سازمانی. در صورت لزوم، کروم دانلود روی دیسک را مسدود کرده و فایل را مستقیماً در گوگل درایو دانلود می‌کند.

DoubleDelta

خواص

  • فعلی

    شماره اختیاری

  • قبلی

    شماره اختیاری

DownloadDelta

خواص

  • canResume

    بولین دلتا اختیاری است

    تغییر در canResume ، در صورت وجود.

  • خطر

    StringDelta اختیاری است

    تغییر در danger ، در صورت وجود.

  • پایان زمان

    StringDelta اختیاری است

    تغییر در endTime ، در صورت وجود.

  • خطا

    StringDelta اختیاری است

    تغییر در error ، در صورت وجود.

  • وجود دارد

    بولین دلتا اختیاری است

    اگر تغییری وجود داشته باشد، این تغییر exists .

  • اندازه فایل

    دابل دلتا اختیاری

    تغییر در fileSize ، در صورت وجود.

  • نام فایل

    StringDelta اختیاری است

    تغییر در filename ، در صورت وجود.

  • نهاییUrl

    StringDelta اختیاری است

    کروم ۵۴+

    تغییر در finalUrl ، در صورت وجود.

  • شناسه

    شماره

    id DownloadItem که تغییر کرده است.

  • میم

    StringDelta اختیاری است

    تغییر در mime ، در صورت وجود.

  • مکث کرد

    بولین دلتا اختیاری است

    تغییر، در صورت وجود، paused .

  • زمان شروع

    StringDelta اختیاری است

    تغییر در startTime ، در صورت وجود.

  • ایالت

    StringDelta اختیاری است

    تغییر در state ، در صورت وجود.

  • کل بایت‌ها

    دابل دلتا اختیاری

    تغییر در totalBytes ، در صورت وجود.

  • آدرس اینترنتی

    StringDelta اختیاری است

    تغییر در url ، در صورت وجود.

DownloadItem

خواص

  • توسط شناسه افزونه

    رشته اختیاری

    شناسه‌ی افزونه‌ای که این دانلود را آغاز کرده است، در صورتی که این دانلود توسط یک افزونه آغاز شده باشد. پس از تنظیم، تغییر نمی‌کند.

  • توسط نام افزونه

    رشته اختیاری

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

  • بایت‌های دریافتی

    شماره

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

  • canResume

    بولی

    اگر دانلود در حال انجام باشد و متوقف شده باشد، یا اگر قطع شده باشد و بتوان آن را از جایی که قطع شده است از سر گرفت، صحیح است.

  • نشان می‌دهد که آیا این دانلود امن تلقی می‌شود یا مشکوک شناخته شده است.

  • پایان زمان

    رشته اختیاری

    زمان پایان دانلود با فرمت ISO 8601. می‌تواند مستقیماً به سازنده‌ی Date ارسال شود: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • خطا

    دلیل وقفه اختیاری

    چرا دانلود قطع شد. انواع مختلفی از خطاهای HTTP را می‌توان تحت یکی از خطاهایی که با SERVER_ شروع می‌شوند، گروه‌بندی کرد. خطاهای مربوط به شبکه با NETWORK_ ، خطاهای مربوط به فرآیند نوشتن فایل در سیستم فایل با FILE_ و وقفه‌های ایجاد شده توسط کاربر با USER_ شروع می‌شوند.

  • زمان پایان تخمینی

    رشته اختیاری

    زمان تخمینی تکمیل دانلود در قالب ISO 8601. می‌تواند مستقیماً به سازنده‌ی Date ارسال شود: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

  • وجود دارد

    بولی

    آیا فایل دانلود شده هنوز وجود دارد یا خیر. این اطلاعات ممکن است قدیمی باشد زیرا کروم به طور خودکار حذف فایل را بررسی نمی‌کند. برای بررسی وجود فایل، تابع search () را فراخوانی کنید. پس از اتمام بررسی وجود فایل، اگر فایل حذف شده باشد، یک رویداد onChanged اجرا می‌شود. توجه داشته باشید که search () قبل از بازگشت منتظر اتمام بررسی وجود فایل نمی‌ماند، بنابراین نتایج حاصل از search () ممکن است به طور دقیق سیستم فایل را منعکس نکنند. همچنین، search () ممکن است هر چند بار که لازم باشد فراخوانی شود، اما بیش از هر 10 ثانیه یک بار وجود فایل را بررسی نمی‌کند.

  • اندازه فایل

    شماره

    تعداد بایت‌های کل فایل پس از خارج کردن از حالت فشرده، یا -۱ در صورت عدم اطلاع.

  • نام فایل

    رشته

    مسیر محلی مطلق.

  • نهاییUrl

    رشته

    کروم ۵۴+

    آدرس اینترنتی (URL) قطعی که این دانلود از آن انجام می‌شود، پس از همه تغییر مسیرها.

  • شناسه

    شماره

    شناسه‌ای که در طول جلسات مرورگر پایدار است.

  • ناشناس

    بولی

    اگر این دانلود در تاریخچه ثبت شده باشد، مقدار false و اگر ثبت نشده باشد، مقدار true را برمی‌گرداند.

  • میم

    رشته

    نوع MIME فایل.

  • مکث کرد

    بولی

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

  • ارجاع دهنده

    رشته

    آدرس اینترنتی مطلق.

  • زمان شروع

    رشته

    زمان شروع دانلود در قالب ISO 8601. می‌تواند مستقیماً به سازنده‌ی Date ارسال شود: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • ایالت

    ایالت

    نشان می‌دهد که آیا دانلود در حال انجام، قطع شده یا کامل شده است.

  • کل بایت‌ها

    شماره

    تعداد بایت‌های کل فایل، بدون در نظر گرفتن فشرده‌سازی فایل، یا -۱ در صورت نامشخص بودن.

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی (URL) قطعی که این دانلود از آن آغاز شده است، قبل از هرگونه تغییر مسیر (ریدایرکت).

DownloadOptions

خواص

  • بدن

    رشته اختیاری

    بدنه پست.

  • درگیری، اکشن

    نام فایلاختلافعمل اختیاری

    اقدامی که در صورت وجود filename انجام می‌شود.

  • نام فایل

    رشته اختیاری

    یک مسیر فایل نسبت به دایرکتوری Downloads که فایل دانلود شده را در خود جای می‌دهد، احتمالاً حاوی زیر دایرکتوری‌ها. مسیرهای مطلق، مسیرهای خالی و مسیرهای حاوی ارجاعات معکوس ".." باعث ایجاد خطا می‌شوند. onDeterminingFilename امکان پیشنهاد نام فایل را پس از تعیین نوع MIME فایل و یک نام فایل آزمایشی فراهم می‌کند.

  • سربرگ‌ها

    جفت نام و مقدار سرآیند [] اختیاری

    هدرهای HTTP اضافی برای ارسال با درخواست در صورتی که URL از پروتکل HTTP[s] استفاده کند. هر هدر به صورت یک دیکشنری حاوی name کلیدها و value یا binaryValue نمایش داده می‌شود که محدود به موارد مجاز توسط XMLHttpRequest است.

  • روش

    HttpMethod اختیاری است

    متد HTTP که در صورتی که URL از پروتکل HTTP[S] استفاده کند، استفاده می‌شود.

  • ذخیره اس

    بولی اختیاری

    از یک انتخابگر فایل استفاده کنید تا به کاربر اجازه دهید نام فایل را انتخاب کند، صرف نظر از اینکه آیا filename تنظیم شده است یا از قبل وجود دارد.

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی برای دانلود.

DownloadQuery

خواص

  • بایت‌های دریافتی

    شماره اختیاری

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

  • خطر

    نوع خطر اختیاری

    نشان می‌دهد که آیا این دانلود امن تلقی می‌شود یا مشکوک شناخته شده است.

  • پایان زمان

    رشته اختیاری

    زمان پایان دانلود در قالب ISO 8601.

  • پایان یافتبعد از

    رشته اختیاری

    نتایج را به DownloadItem که پس از ms داده شده در قالب ISO 8601 خاتمه یافته است، محدود می‌کند.

  • قبل از

    رشته اختیاری

    نتایج را به DownloadItem که قبل از ms داده شده در قالب ISO 8601 پایان یافته است، محدود می‌کند.

  • خطا

    دلیل وقفه اختیاری

    چرا دانلود قطع شد.

  • وجود دارد

    بولی اختیاری

    اینکه آیا فایل دانلود شده وجود دارد یا خیر؛

  • اندازه فایل

    شماره اختیاری

    تعداد بایت‌های کل فایل پس از خارج کردن از حالت فشرده، یا -۱ در صورت عدم اطلاع.

  • نام فایل

    رشته اختیاری

    مسیر محلی مطلق.

  • نام فایلRegex

    رشته اختیاری

    نتایج را به DownloadItem که filename آن با عبارت منظم داده شده مطابقت دارد، محدود می‌کند.

  • نهاییUrl

    رشته اختیاری

    کروم ۵۴+

    آدرس اینترنتی (URL) قطعی که این دانلود از آن انجام می‌شود، پس از همه تغییر مسیرها.

  • finalUrlRegex

    رشته اختیاری

    کروم ۵۴+

    نتایج را به DownloadItem که finalUrl آن با عبارت منظم داده شده مطابقت دارد، محدود می‌کند.

  • شناسه

    شماره اختیاری

    id DownloadItem که قرار است جستجو شود.

  • حد

    شماره اختیاری

    حداکثر تعداد DownloadItem منطبق بازگردانده شده. مقدار پیش‌فرض ۱۰۰۰ است. برای بازگرداندن تمام DownloadItem منطبق، روی ۰ تنظیم کنید. برای نحوه پیمایش نتایج به search مراجعه کنید.

  • میم

    رشته اختیاری

    نوع MIME فایل.

  • سفارش توسط

    رشته[] اختیاری

    عناصر این آرایه را به منظور مرتب‌سازی نتایج جستجو، روی ویژگی‌های DownloadItem تنظیم کنید. برای مثال، تنظیم orderBy=['startTime'] DownloadItem را بر اساس زمان شروع آنها به ترتیب صعودی مرتب می‌کند. برای تعیین ترتیب نزولی، از یک خط تیره قبل از آن استفاده کنید: '-startTime'.

  • مکث کرد

    بولی اختیاری

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

  • پرس و جو

    رشته[] اختیاری

    این آرایه از عبارات جستجو، نتایج را به DownloadItem محدود می‌کند که filename یا url یا finalUrl آنها شامل تمام عبارات جستجویی باشد که با خط تیره '-' شروع نمی‌شوند و هیچ یک از عبارات جستجویی که با خط تیره شروع می‌شوند، در آنها وجود نداشته باشد.

  • زمان شروع

    رشته اختیاری

    زمان شروع دانلود با فرمت ISO 8601.

  • شروع شدبعد از

    رشته اختیاری

    نتایج را به DownloadItem که پس از ms داده شده در قالب ISO 8601 شروع شده‌اند، محدود می‌کند.

  • شروع شدهقبل از

    رشته اختیاری

    نتایج را به DownloadItem که قبل از ms داده شده در قالب ISO 8601 شروع شده است، محدود می‌کند.

  • ایالت

    حالت اختیاری

    نشان می‌دهد که آیا دانلود در حال انجام، قطع شده یا کامل شده است.

  • کل بایت‌ها

    شماره اختیاری

    تعداد بایت‌های کل فایل، بدون در نظر گرفتن فشرده‌سازی فایل، یا -۱ در صورت نامشخص بودن.

  • totalBytesGreater

    شماره اختیاری

    نتایج را به DownloadItem محدود می‌کند که totalBytes آنها بزرگتر از عدد صحیح داده شده باشد.

  • totalBytesLess

    شماره اختیاری

    نتایج را به DownloadItem محدود می‌کند که totalBytes آنها کمتر از عدد صحیح داده شده باشد.

  • آدرس اینترنتی

    رشته اختیاری

    آدرس اینترنتی (URL) قطعی که این دانلود از آن آغاز شده است، قبل از هرگونه تغییر مسیر (ریدایرکت).

  • urlRegex

    رشته اختیاری

    نتایج را به DownloadItem که url آن با عبارت منظم داده شده مطابقت دارد، محدود می‌کند.

FilenameConflictAction

منحصر به فرد کردن

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

بازنویسی

فایل موجود با فایل جدید جایگزین خواهد شد.

سریع

کاربر با یک کادر محاوره‌ای انتخاب فایل مواجه می‌شود.

شمارشی

"یگانه کردن"

"رونویسی"

"سریع"

FilenameSuggestion

خواص

  • درگیری، اکشن

    نام فایلاختلافعمل اختیاری

    اقدامی که در صورت وجود filename انجام می‌شود.

  • نام فایل

    رشته

    هدف جدید DownloadItem ، DownloadItem.filename ، به عنوان مسیری نسبت به دایرکتوری پیش‌فرض دانلودهای کاربر، که احتمالاً شامل زیردایرکتوری‌ها نیز می‌شود. مسیرهای مطلق، مسیرهای خالی و مسیرهای حاوی ارجاعات معکوس ".." نادیده گرفته می‌شوند. filename در صورتی که هرگونه شنونده onDeterminingFilename ثبت شده توسط هر افزونه‌ای وجود داشته باشد، نادیده گرفته می‌شود.

GetFileIconOptions

خواص

  • اندازه

    شماره اختیاری

    اندازه آیکون برگشتی. آیکون مربعی شکل با ابعاد size * size پیکسل خواهد بود. اندازه پیش‌فرض و بزرگترین اندازه برای آیکون ۳۲x۳۲ پیکسل است. تنها اندازه‌های پشتیبانی شده ۱۶ و ۳۲ هستند. تعیین اندازه دیگری خطا محسوب می‌شود.

HeaderNameValuePair

خواص

  • نام

    رشته

    نام هدر HTTP.

  • ارزش

    رشته

    مقدار هدر HTTP.

HttpMethod

شمارشی

«دریافت»

«پست»

InterruptReason

شمارشی

"فایل_ناموفق"

«دسترسی_به_فایل_ممنوع»

"فایل_بدون_فضا"

"نام_فایل_خیلی_طولانی"

"فایل خیلی بزرگ"

«فایل_آلوده_به_ویروس»

"خطای گذرای فایل"

«فایل مسدود شده»

"بررسی_امنیت_فایل_ناموفق"

"فایل خیلی کوتاه"

"عدم تطابق هش فایل"

"فایل_همان_منبع_فایل"

"شبکه_ناموفق"

"زمان_اتمام_شبکه"

«شبکه_قطع_شد»

"شبکه_سرور_از_کار_افتاده"

"درخواست_نامعتبر_شبکه"

"سرور_ناموفق"

"بدون محدوده سرور"

«محتوای_نامربوط_سرور»

«سرور_غیرمجاز»

مشکل سرور CERT

«سرور_ممنوعه»

"سرور_غیرقابل_دسترس"

"عدم تطابق طول_محتوای_سرور"

"سرور_صلیب_اصلی_ریدیرکت"

"کاربر_لغو شد"

"کاربر_خاموش"

"سقوط"

State

در حال انجام

دانلود در حال حاضر در حال دریافت داده از سرور است.

قطع شده

خطایی باعث قطع ارتباط با میزبان فایل شد.

کامل

دانلود با موفقیت به پایان رسید.

شمارشی

"در_حال_انجام"

"قطع شده"

"کامل"

StringDelta

خواص

  • فعلی

    رشته اختیاری

  • قبلی

    رشته اختیاری

UiOptions

کروم ۱۰۵+

خواص

  • فعال شده

    بولی

    رابط کاربری دانلود را فعال یا غیرفعال کنید.

روش‌ها

acceptDanger()

chrome.downloads.acceptDanger(
  downloadId: number,
): Promise<void>

از کاربر می‌خواهد که دانلود خطرناک را بپذیرد. فقط از یک زمینه قابل مشاهده (تب، پنجره یا پنجره بازشو صفحه/مرورگر) قابل فراخوانی است. دانلودهای خطرناک را به طور خودکار نمی‌پذیرد. اگر دانلود پذیرفته شود، یک رویداد onChanged اجرا می‌شود، در غیر این صورت هیچ اتفاقی نمی‌افتد. وقتی همه داده‌ها در یک فایل موقت واکشی شوند و دانلود خطرناک نباشد یا خطر پذیرفته شده باشد، فایل موقت به نام فایل هدف تغییر نام می‌دهد، state به 'کامل' تغییر می‌کند و onChanged اجرا می‌شود.

پارامترها

  • دانلودآیدی

    شماره

    شناسه‌ی مربوط به DownloadItem .

بازگشت‌ها

  • قول<void>

    کروم ۹۶+

cancel()

chrome.downloads.cancel(
  downloadId: number,
): Promise<void>

لغو دانلود. وقتی callback اجرا می‌شود، دانلود لغو، تکمیل، قطع یا دیگر وجود ندارد.

پارامترها

  • دانلودآیدی

    شماره

    شناسه‌ی دانلودی که قرار است لغو شود.

بازگشت‌ها

  • قول<void>

    کروم ۹۶+

download()

chrome.downloads.download(
  options: DownloadOptions,
): Promise<number>

دانلود یک URL. اگر URL از پروتکل HTTP[S] استفاده کند، درخواست شامل تمام کوکی‌هایی خواهد بود که در حال حاضر برای نام میزبان آن تنظیم شده‌اند. اگر هم filename و هم saveAs مشخص شده باشند، کادر محاوره‌ای Save As نمایش داده می‌شود که از قبل با filename مشخص شده پر شده است. اگر دانلود با موفقیت شروع شود، callback با downloadId جدید DownloadItem فراخوانی می‌شود. اگر در شروع دانلود خطایی رخ داده باشد، callback با downloadId=undefined فراخوانی می‌شود و runtime.lastError شامل یک رشته توصیفی خواهد بود. تضمینی وجود ندارد که رشته‌های خطا بین نسخه‌های مختلف سازگار باقی بمانند. افزونه‌ها نباید آن را تجزیه کنند.

پارامترها

بازگشت‌ها

  • قول<number>

    کروم ۹۶+

erase()

chrome.downloads.erase(
  query: DownloadQuery,
): Promise<number[]>

حذف DownloadItem منطبق از تاریخچه بدون حذف فایل دانلود شده. یک رویداد onErased برای هر DownloadItem که با query مطابقت دارد، فعال می‌شود و سپس callback فراخوانی می‌شود.

پارامترها

بازگشت‌ها

  • قول<number[]>

    کروم ۹۶+

getFileIcon()

chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
): Promise<string | undefined>

بازیابی یک آیکون برای دانلود مشخص شده. برای دانلودهای جدید، آیکون‌های فایل پس از دریافت رویداد onCreated در دسترس هستند. تصویری که توسط این تابع در حین انجام دانلود برگردانده می‌شود، ممکن است با تصویری که پس از اتمام دانلود برگردانده می‌شود، متفاوت باشد. بازیابی آیکون با پرس و جو از سیستم عامل یا ابزار مربوطه، بسته به پلتفرم، انجام می‌شود. بنابراین، آیکونی که برگردانده می‌شود به عوامل مختلفی از جمله وضعیت دانلود، پلتفرم، انواع فایل‌های ثبت شده و تم بصری بستگی دارد. اگر آیکون فایل قابل تعیین نباشد، runtime.lastError حاوی یک پیام خطا خواهد بود.

پارامترها

  • دانلودآیدی

    شماره

    شناسه برای دانلود.

  • گزینه‌ها

    GetFileIconOptions اختیاری است

بازگشت‌ها

  • قول <string | undefined>

    کروم ۹۶+

open()

chrome.downloads.open(
  downloadId: number,
): Promise<void>

اگر DownloadItem کامل شده باشد، فایل دانلود شده را اکنون باز می‌کند؛ در غیر این صورت از طریق runtime.lastError خطایی برمی‌گرداند. این متد علاوه بر مجوز "downloads" "downloads.open" نیز نیاز دارد. رویداد onChanged زمانی رخ می‌دهد که آیتم برای اولین بار باز شود. این متد فقط می‌تواند در پاسخ به یک حرکت کاربر فراخوانی شود.

پارامترها

  • دانلودآیدی

    شماره

    شناسه فایل دانلود شده.

بازگشت‌ها

  • قول<void>

    کروم ۱۲۳+

pause()

chrome.downloads.pause(
  downloadId: number,
): Promise<void>

دانلود را متوقف کنید. اگر درخواست موفقیت‌آمیز بود، دانلود در حالت مکث قرار می‌گیرد. در غیر این صورت runtime.lastError حاوی یک پیام خطا است. اگر دانلود فعال نباشد، درخواست با شکست مواجه خواهد شد.

پارامترها

  • دانلودآیدی

    شماره

    شناسه‌ی دانلودی که قرار است متوقف شود.

بازگشت‌ها

  • قول<void>

    کروم ۹۶+

removeFile()

chrome.downloads.removeFile(
  downloadId: number,
): Promise<void>

اگر فایل دانلود شده وجود دارد و DownloadItem کامل است، آن را حذف کنید؛ در غیر این صورت از طریق runtime.lastError خطایی را برگردانید.

پارامترها

  • دانلودآیدی

    شماره

بازگشت‌ها

  • قول<void>

    کروم ۹۶+

resume()

chrome.downloads.resume(
  downloadId: number,
): Promise<void>

دانلود متوقف شده را از سر می‌گیرد. اگر درخواست موفقیت‌آمیز بود، دانلود در حال انجام و بدون توقف است. در غیر این صورت runtime.lastError حاوی یک پیام خطا است. اگر دانلود فعال نباشد، درخواست با شکست مواجه خواهد شد.

پارامترها

  • دانلودآیدی

    شماره

    شناسه دانلودی که قرار است از سر گرفته شود.

بازگشت‌ها

  • قول<void>

    کروم ۹۶+
chrome.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

DownloadItem پیدا کنید. query روی شیء خالی تنظیم کنید تا تمام DownloadItem دریافت کنید. برای دریافت یک DownloadItem خاص، فقط فیلد id را تنظیم کنید. برای پیمایش تعداد زیادی از آیتم‌ها، orderBy: ['-startTime'] را تنظیم کنید، limit تعداد آیتم‌ها در هر صفحه را تعیین کنید و startedAfter را روی startTime آخرین آیتم از آخرین صفحه تنظیم کنید.

پارامترها

بازگشت‌ها

setShelfEnabled()

از نسخه ۱۱۷ کروم منسوخ شده است
 
chrome.downloads.setShelfEnabled(
  enabled: boolean,
): void

به جای آن از setUiOptions استفاده کنید.

قفسه خاکستری را در پایین هر پنجره مرتبط با نمایه مرورگر فعلی فعال یا غیرفعال کنید. قفسه تا زمانی که حداقل یک افزونه آن را غیرفعال کرده باشد، غیرفعال خواهد بود. فعال کردن قفسه در حالی که حداقل یک افزونه دیگر غیرفعال شده است، خطایی را از طریق runtime.lastError برمی‌گرداند. علاوه بر مجوز "downloads" به مجوز "downloads.shelf" نیز نیاز دارد.

پارامترها

  • فعال شده

    بولی

setUiOptions()

کروم ۱۰۵+
chrome.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

رابط کاربری دانلود هر پنجره مرتبط با نمایه مرورگر فعلی را تغییر دهید. تا زمانی که حداقل یک افزونه UiOptions.enabled را روی false تنظیم کرده باشد، رابط کاربری دانلود پنهان خواهد بود. تنظیم UiOptions.enabled روی true در حالی که حداقل یک افزونه دیگر غیرفعال شده باشد، از طریق runtime.lastError خطایی را برمی‌گرداند. علاوه بر مجوز "downloads" به مجوز "downloads.ui" نیز نیاز دارد.

پارامترها

بازگشت‌ها

  • قول<void>

show()

chrome.downloads.show(
  downloadId: number,
): void

فایل دانلود شده را در پوشه مربوط به آن در فایل منیجر نمایش دهید.

پارامترها

  • دانلودآیدی

    شماره

    شناسه فایل دانلود شده.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

پوشه پیش‌فرض دانلودها را در فایل منیجر نمایش دهید.

رویدادها

onChanged

chrome.downloads.onChanged.addListener(
  callback: function,
)

وقتی هر یک از ویژگی‌های DownloadItem به جز bytesReceived و estimatedEndTime تغییر کند، این رویداد با downloadId و یک شیء حاوی ویژگی‌هایی که تغییر کرده‌اند، فعال می‌شود.

پارامترها

onCreated

chrome.downloads.onCreated.addListener(
  callback: function,
)

این رویداد با شروع دانلود، با شیء DownloadItem فعال می‌شود.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (downloadItem: DownloadItem) => void

onDeterminingFilename

chrome.downloads.onDeterminingFilename.addListener(
  callback: function,
)

در طول فرآیند تعیین نام فایل، به افزونه‌ها این فرصت داده می‌شود که DownloadItem.filename هدف را لغو کنند. هر افزونه نمی‌تواند بیش از یک شنونده برای این رویداد ثبت کند. هر شنونده باید دقیقاً یک بار، چه به صورت همزمان و چه به صورت غیرهمزمان، suggest فراخوانی کند. اگر شنونده suggest به صورت غیرهمزمان فراخوانی کند، باید true برگرداند. اگر شنونده نه suggest به صورت همزمان فراخوانی کند و نه true برگرداند، suggest به طور خودکار فراخوانی می‌شود. DownloadItem تا زمانی که همه شنونده‌ها suggest فراخوانی نکرده باشند، کامل نمی‌شود. شنونده‌ها می‌توانند suggest بدون هیچ آرگومانی فراخوانی کنند تا به دانلود اجازه دهند از downloadItem.filename برای نام فایل خود استفاده کند، یا یک شیء suggestion را به suggest ارسال کنند تا نام فایل هدف را لغو کند. اگر بیش از یک افزونه نام فایل را لغو کند، آخرین افزونه نصب شده‌ای که شنونده آن یک شیء suggestion را به suggest ارسال می‌کند، برنده می‌شود. برای جلوگیری از سردرگمی در مورد اینکه کدام افزونه برنده خواهد شد، کاربران نباید افزونه‌هایی را که ممکن است با هم تداخل داشته باشند نصب کنند. اگر دانلود با download آغاز شده باشد و نام فایل هدف قبل از تعیین نوع MIME و نام فایل آزمایشی مشخص شده باشد، به جای آن filename به download ارسال کنید.

پارامترها

onErased

chrome.downloads.onErased.addListener(
  callback: function,
)

وقتی یک دانلود از تاریخچه پاک می‌شود، با downloadId فعال می‌شود.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (downloadId: number) => void

    • دانلودآیدی

      شماره