chrome.downloads

توضیحات

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

مجوزها

downloads

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

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

نمونه ها

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

انواع

BooleanDelta

خواص

  • جاری

    بولی اختیاری

  • قبلی

    بولی اختیاری

DangerType

فایل

نام فایل دانلود مشکوک است.

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

URL دانلود به عنوان مخرب شناخته شده است.

محتوا

فایل دانلود شده به عنوان مخرب شناخته شده است.

غیر معمول

URL دانلود معمولاً دانلود نمی شود و می تواند خطرناک باشد.

میزبان

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

ناخواسته

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

امن

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

پذیرفته شد

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

Enum

"پرونده"

"url"

"محتوا"

"غیر معمول"

"میزبان"

"ناخواسته"

"ایمن"

"پذیرفته شده"

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"محافظت از رمز عبور"

"blockedTooLarge"

"هشدار محتوای حساس"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"DeepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"حساب سازش"

"blockedScanFailed"

DoubleDelta

خواص

  • جاری

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

  • قبلی

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

DownloadDelta

خواص

  • می توان از سر گرفت

    BooleanDelta اختیاری است

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

  • خطر

    StringDelta اختیاری است

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

  • پایان زمان

    StringDelta اختیاری است

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

  • خطا

    StringDelta اختیاری است

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

  • وجود دارد

    BooleanDelta اختیاری است

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

  • اندازه فایل

    DoubleDelta اختیاری است

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

  • نام فایل

    StringDelta اختیاری است

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

  • آدرس نهایی

    StringDelta اختیاری است

    Chrome 54+

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

  • شناسه

    شماره

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

  • میم

    StringDelta اختیاری است

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

  • مکث کرد

    BooleanDelta اختیاری است

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

  • زمان شروع

    StringDelta اختیاری است

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

  • دولت

    StringDelta اختیاری است

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

  • کل بایت

    DoubleDelta اختیاری است

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

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

    StringDelta اختیاری است

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

DownloadItem

خواص

  • byExtensionId

    رشته اختیاری

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

  • byExtensionName

    رشته اختیاری

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

  • بایت دریافت شد

    شماره

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

  • می توان از سر گرفت

    بولی

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

  • نشان می دهد که آیا تصور می شود این دانلود ایمن است یا مشکوک است.

  • پایان زمان

    رشته اختیاری

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

  • خطا

    InterruptReason اختیاری است

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

  • برآورد پایان زمان

    رشته اختیاری

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

  • وجود دارد

    بولی

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

  • اندازه فایل

    شماره

    تعداد بایت ها در کل فایل پس از فشرده سازی یا -1 در صورت ناشناخته بودن.

  • نام فایل

    رشته

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

  • آدرس نهایی

    رشته

    Chrome 54+

    URL مطلقی که این دانلود از آن ساخته شده است، پس از همه تغییر مسیرها.

  • شناسه

    شماره

    شناسه ای که در تمام جلسات مرورگر ثابت است.

  • ناشناس

    بولی

    اگر این دانلود در تاریخچه ثبت شده باشد نادرست است، اگر ضبط نشده باشد درست است.

  • میم

    رشته

    نوع MIME فایل.

  • مکث کرد

    بولی

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

  • ارجاع دهنده

    رشته

    URL مطلق.

  • زمان شروع

    رشته

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

  • دولت

    ایالت

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

  • کل بایت

    شماره

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

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

    رشته

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

DownloadOptions

خواص

  • بدن

    رشته اختیاری

    بدن پست.

  • تضاد اقدام

    FilenameConflictAction اختیاری است

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

  • نام فایل

    رشته اختیاری

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

  • سرصفحه ها

    HeaderNameValuePair [] اختیاری است

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

  • روش

    HttpMethod اختیاری است

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

  • saveAs

    بولی اختیاری

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

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

    رشته

    URL برای دانلود.

DownloadQuery

خواص

  • بایت دریافت شد

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

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

  • خطر

    DangerType اختیاری است

    نشان می دهد که آیا تصور می شود این دانلود ایمن است یا مشکوک است.

  • پایان زمان

    رشته اختیاری

    زمانی که دانلود با فرمت ISO 8601 به پایان رسید.

  • پایان یافت پس از

    رشته اختیاری

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

  • پایان یافت قبل از

    رشته اختیاری

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

  • خطا

    InterruptReason اختیاری است

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

  • وجود دارد

    بولی اختیاری

    آیا فایل دانلود شده وجود دارد.

  • اندازه فایل

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

    تعداد بایت ها در کل فایل پس از فشرده سازی یا -1 در صورت ناشناخته بودن.

  • نام فایل

    رشته اختیاری

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

  • نام فایلRegex

    رشته اختیاری

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

  • آدرس نهایی

    رشته اختیاری

    Chrome 54+

    URL مطلقی که این دانلود از آن ساخته شده است، پس از همه تغییر مسیرها.

  • finalUrlRegex

    رشته اختیاری

    Chrome 54+

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

  • شناسه

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

    id DownloadItem برای پرس و جو.

  • محدود کردن

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

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

  • میم

    رشته اختیاری

    نوع MIME فایل.

  • سفارش توسط

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

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

  • مکث کرد

    بولی اختیاری

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

  • پرس و جو

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

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

  • زمان شروع

    رشته اختیاری

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

  • شروع بعد از

    رشته اختیاری

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

  • قبل از شروع

    رشته اختیاری

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

  • دولت

    حالت اختیاری

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

  • کل بایت

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

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

  • totalBytesGreater

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

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

  • totalBytesLess

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

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

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

    رشته اختیاری

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

  • urlRegex

    رشته اختیاری

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

FilenameConflictAction

یکپارچه کردن

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

رونویسی

فایل موجود با فایل جدید رونویسی می شود.

سریع

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

Enum

"یکسان کردن"

"بازنویسی"

"سریع"

FilenameSuggestion

خواص

  • تضاد اقدام

    FilenameConflictAction اختیاری است

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

  • نام فایل

    رشته

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

GetFileIconOptions

خواص

  • اندازه

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

    اندازه نماد برگشتی نماد مربع با ابعاد اندازه * اندازه پیکسل خواهد بود. اندازه پیش‌فرض و بزرگ‌ترین اندازه برای نماد 32x32 پیکسل است. تنها اندازه‌های پشتیبانی شده 16 و 32 هستند. تعیین هر اندازه دیگری یک خطا است.

HeaderNameValuePair

خواص

  • نام

    رشته

    نام هدر HTTP.

  • ارزش

    رشته

    مقدار هدر HTTP.

HttpMethod

Enum

"دریافت"

"پست"

InterruptReason

Enum

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

"FILE_NAME_TOO_LONG"

"FILE_TOO_LARGE"

"FILE_VIRUS_INFECTED"

"FILE_TRANSIENT_ERROR"

"FILE_BLOCKED"

"FILE_SECURITY_CHECK_FAILED"

"FILE_TOO_SHORT"

"FILE_HASH_MISMATCH"

"FILE_SAME_AS_SOURCE"

"NETWORK_FAILED"

"NETWORK_TIMEOUT"

"NETWORK_DISCONNECTED"

"NETWORK_SERVER_DOWN"

"NETWORK_INVALID_REQUEST"

"SERVER_FAILED"

"SERVER_NO_RANGE"

"SERVER_BAD_CONTENT"

"SERVER_UNAUTHORIZED"

"SERVER_CERT_PROBLEM"

"SERVER_FORBIDDEN"

"SERVER_UNREACHABLE"

"SERVER_CONTENT_LENGTH_MISMATCH"

"SERVER_CROSS_ORIGIN_REDIRECT"

"USER_CANCELED"

"USER_SHUTDOWN"

"سقوط"

State

در حال پیشرفت

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

قطع شد

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

کامل

دانلود با موفقیت انجام شد.

Enum

"در حال پیشرفت"

"قطع"

"کامل"

StringDelta

خواص

  • جاری

    رشته اختیاری

  • قبلی

    رشته اختیاری

UiOptions

Chrome 105+

خواص

  • فعال شد

    بولی

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

روش ها

acceptDanger()

قول بده
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

    شناسه DownloadItem .

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

cancel()

قول بده
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

download()

قول بده
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

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

پارامترها

  • چه چیزی و چگونه دانلود شود.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (downloadId: number) => void

    • شناسه دانلود

      شماره

برمی گرداند

  • قول <تعداد>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

erase()

قول بده
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
)

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

پارامترها

  • پرس و جو

    DownloadQuery

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (erasedIds: number[]) => void

    • erasedIds

      شماره[]

برمی گرداند

  • قول <شماره[]>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getFileIcon()

قول بده
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

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

  • گزینه ها

    GetFileIconOptions اختیاری است

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (iconURL?: string) => void

    • iconURL

      رشته اختیاری

برمی گرداند

  • قول<رشته | تعریف نشده>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

open()

قول بده
chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    Chrome 123+

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 123+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

pause()

قول بده
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

removeFile()

قول بده
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

resume()

قول بده
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

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

پارامترها

  • شناسه دانلود

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

قول بده
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

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

پارامترها

برمی گرداند

  • Promise< DownloadItem []>

    Chrome 96+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setShelfEnabled()

از Chrome 117 منسوخ شده است
 
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

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

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

پارامترها

  • فعال شد

    بولی

setUiOptions()

Promise Chrome 105+
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

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

پارامترها

  • گزینه ها

    UiOptions

    یک تغییر در رابط کاربری دانلود را کپسوله کنید.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

show()

chrome.downloads.show(
  downloadId: number,
)

فایل دانلود شده را در پوشه آن در یک مدیر فایل نمایش دهید.

پارامترها

  • شناسه دانلود

    شماره

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

showDefaultFolder()

chrome.downloads.showDefaultFolder()

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

رویدادها

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 به‌طور خودکار فراخوانی می‌شود. تا زمانی که همه شنوندگان suggest را فراخوانی نکنند، DownloadItem تکمیل نخواهد شد. شنوندگان ممکن است suggest بدون هیچ استدلالی فراخوانی کنند تا به دانلود اجازه دهند downloadItem.filename برای نام فایل خود استفاده کند، یا یک شی suggestion را برای suggest به منظور لغو نام فایل مورد نظر ارسال کنند. اگر بیش از یک پسوند نام فایل را لغو کند، آخرین پسوند نصب شده که شنونده آن یک شی suggestion برای suggest ارسال می کند برنده می شود. به منظور جلوگیری از سردرگمی در مورد اینکه کدام برنامه افزودنی برنده خواهد شد، کاربران نباید افزونه هایی را نصب کنند که ممکن است تداخل داشته باشند. اگر دانلود با download آغاز شده است و نام فایل مورد نظر قبل از تعیین نوع MIME و نام فایل آزمایشی شناخته شده است، به جای آن filename برای download ارسال کنید.

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (downloadItem: DownloadItem, suggest: function) => void

onErased

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (downloadId: number) => void

    • شناسه دانلود

      شماره