chrome.downloads

תאריך הרענון: 2026-09-25 robots: noindex

ההרשאה הזו מפעילה אזהרה

תיאור

משתמשים ב-chrome.downloads API כדי להתחיל, לעקוב, לשנות ולחפש הורדות באופן פרוגרמטי.

הרשאות

downloads

מניפסט

כדי להשתמש ב-API הזה, צריך להצהיר על ההרשאה "downloads" במניפסט התוסף.

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

דוגמאות

תוכלו למצוא דוגמאות פשוטות לשימוש ב-chrome.downloads API בספרייה examples/api/downloads. דוגמאות נוספות ועזרה בצפייה בקוד המקור זמינות במאמר דוגמאות.

סוגים

BooleanDelta

מאפיינים

  • current, קורנט

    ‫boolean אופציונלי

  • הקודם

    ‫boolean אופציונלי

DangerType

ספירה

file
שם הקובץ של ההורדה מעורר חשד.

‫"url"
כתובת ה-URL של ההורדה ידועה כזדונית.

‫content
הקובץ שהורד ידוע כקובץ זדוני.

"לא נפוץ"
כתובת ה-URL של ההורדה לא נפוצה ויכול להיות שהיא מסוכנת.

‫host
ההורדה הגיעה ממארח שידוע שמפיץ קבצים בינאריים זדוניים, ולכן סביר להניח שהיא מסוכנת.

"לא רצוי"
ההורדה עלולה להיות לא רצויה או לא בטוחה. לדוגמה, היא יכולה לבצע שינויים בהגדרות הדפדפן או המחשב.

"בטוח"
ההורדה לא מציגה סכנה ידועה למחשב של המשתמש.

‫accepted
המשתמש אישר את ההורדה המסוכנת.

‫"allowlistedByPolicy"
ערכים שקשורים לארגון.

"asyncScanning"

"asyncLocalPasswordScanning"

‫"passwordProtected"

‫"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

‫"deepScannedFailed"

‫"deepScannedSafe"

‫"deepScannedOpenedDangerous"

‫"promptForScanning"

"promptForLocalPasswordScanning"

‫"accountCompromise"

‫"blockedScanFailed"

‫"forceSaveToGdrive"
לשימוש בתוסף Secure Enterprise Browser. במקרים שנדרש, Chrome יחסום את ההורדה לדיסק ויוריד את הקובץ ישירות ל-Google Drive.

‫forceSaveToOnedrive
לשימוש בתוסף Secure Enterprise Browser. כשנדרש, Chrome יחסום את ההורדה לדיסק ויוריד את הקובץ ישירות ל-OneDrive.

DoubleDelta

מאפיינים

  • current, קורנט

    מספר אופציונלי

  • הקודם

    מספר אופציונלי

DownloadDelta

מאפיינים

  • canResume

    ‫BooleanDelta אופציונלי

    השינוי בcanResume, אם יש כזה.

  • סכנה

    ‫StringDelta אופציונלי

    השינוי בdanger, אם יש כזה.

  • endTime

    ‫StringDelta אופציונלי

    השינוי בendTime, אם יש כזה.

  • error

    ‫StringDelta אופציונלי

    השינוי בerror, אם יש כזה.

  • קיים

    ‫BooleanDelta אופציונלי

    השינוי בexists, אם יש כזה.

  • fileSize

    ‫DoubleDelta אופציונלי

    השינוי בfileSize, אם יש כזה.

  • שם קובץ

    ‫StringDelta אופציונלי

    השינוי בfilename, אם יש כזה.

  • finalUrl

    ‫StringDelta אופציונלי

    ‫Chrome 54 ואילך

    השינוי בfinalUrl, אם יש כזה.

  • id [מזהה]

    number

    הערך id של DownloadItem שהשתנה.

  • פנטומימה

    ‫StringDelta אופציונלי

    השינוי בmime, אם יש כזה.

  • מושהה

    ‫BooleanDelta אופציונלי

    השינוי בpaused, אם יש כזה.

  • startTime

    ‫StringDelta אופציונלי

    השינוי בstartTime, אם יש כזה.

  • הסמוי הסופי

    ‫StringDelta אופציונלי

    השינוי בstate, אם יש כזה.

  • totalBytes

    ‫DoubleDelta אופציונלי

    השינוי בtotalBytes, אם יש כזה.

  • url

    ‫StringDelta אופציונלי

    השינוי בurl, אם יש כזה.

DownloadItem

מאפיינים

  • byExtensionId

    מחרוזת אופציונלי

    המזהה של התוסף שהתחיל את ההורדה הזו, אם ההורדה התחילה על ידי תוסף. הערך לא משתנה אחרי שהוא מוגדר.

  • byExtensionName

    מחרוזת אופציונלי

    השם המקומי של התוסף שהפעיל את ההורדה הזו, אם ההורדה הופעלה על ידי תוסף. יכול להיות שהערך ישתנה אם שם התוסף ישתנה או אם המשתמש ישנה את הלוקאל שלו.

  • bytesReceived

    number

    מספר הבייטים שהתקבלו עד עכשיו מהמארח, בלי להתחשב בדחיסת הקובץ.

  • canResume

    בוליאני

    הערך הוא True אם ההורדה מתבצעת ומושהית, או אם היא הופסקה ואפשר להמשיך אותה מהמקום שבו היא הופסקה.

  • סכנה

    DangerType

    בעמודה הזו מצוין אם ההורדה הזו נחשבת בטוחה או חשודה.

  • endTime

    מחרוזת אופציונלי

    השעה שבה ההורדה הסתיימה בפורמט ISO 8601. אפשר להעביר ישירות אל constructor של Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • error

    ‫InterruptReason אופציונלי

    למה ההורדה נקטעה. יכול להיות שכמה סוגים של שגיאות HTTP יקובצו תחת אחת מהשגיאות שמתחילות ב-SERVER_. שגיאות שקשורות לרשת מתחילות ב-NETWORK_, שגיאות שקשורות לתהליך הכתיבה של הקובץ למערכת הקבצים מתחילות ב-FILE_, והפרעות שהמשתמש יזם מתחילות ב-USER_.

  • estimatedEndTime

    מחרוזת אופציונלי

    הזמן המשוער לסיום ההורדה בפורמט ISO 8601. אפשר להעביר ישירות אל constructor של Date: 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 שניות.

  • fileSize

    number

    מספר הבייטים בקובץ כולו אחרי הפעולה, או ‎-1 אם לא ידוע.

  • שם קובץ

    מחרוזת

    נתיב מקומי מוחלט.

  • finalUrl

    מחרוזת

    ‫Chrome 54 ואילך

    כתובת URL אבסולוטית שממנה מתבצעת ההורדה, אחרי כל ההפניות האוטומטיות.

  • id [מזהה]

    number

    מזהה שמשתמר בין סשנים בדפדפן.

  • פרטי

    בוליאני

    הערך False אם ההורדה הזו מתועדת בהיסטוריה, הערך True אם היא לא מתועדת.

  • פנטומימה

    מחרוזת

    סוג ה-MIME של הקובץ.

  • מושהה

    בוליאני

    הערך הוא True אם ההורדה הפסיקה לקרוא נתונים מהמארח, אבל השאירה את החיבור פתוח.

  • גורם מפנה

    מחרוזת

    כתובת URL אבסולוטית.

  • startTime

    מחרוזת

    השעה שבה ההורדה התחילה בפורמט ISO 8601. אפשר להעביר ישירות אל constructor של Date: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • הסמוי הסופי

    מדינה

    מציין אם ההורדה מתקדמת, הופסקה או הושלמה.

  • totalBytes

    number

    מספר הבייטים בקובץ כולו, בלי להתחשב בדחיסת הקובץ, או ‎-1 אם לא ידוע.

  • url

    מחרוזת

    כתובת URL אבסולוטית שממנה התחילה ההורדה, לפני כל ההפניות האוטומטיות.

DownloadOptions

מאפיינים

  • body

    מחרוזת אופציונלי

    גוף הפוסט.

  • conflictAction

    ‫FilenameConflictAction אופציונלי

    הפעולה שיש לבצע אם filename כבר קיים.

  • שם קובץ

    מחרוזת אופציונלי

    נתיב קובץ יחסי לספריית ההורדות, שיכיל את הקובץ שהורד, ויכול להיות שיכיל ספריות משנה. נתיבים מוחלטים, נתיבים ריקים ונתיבים שמכילים הפניות חוזרות (back-references) כמו '..' יגרמו לשגיאה. ‫onDeterminingFilename מאפשר להציע שם קובץ אחרי שסוג ה-MIME של הקובץ ושם קובץ זמני נקבעו.

  • כותרות

    ‫HeaderNameValuePair[] optional

    כותרות HTTP נוספות לשליחה עם הבקשה אם כתובת ה-URL משתמשת בפרוטוקול HTTP[s]. כל כותרת מיוצגת כמילון שמכיל את המפתחות name ואת value או binaryValue, ומוגבלת לאלה שמותרים על ידי XMLHttpRequest.

  • method

    ‫HttpMethod אופציונלי

    שיטת ה-HTTP שבה צריך להשתמש אם כתובת ה-URL משתמשת בפרוטוקול HTTP[S].

  • saveAs

    ‫boolean אופציונלי

    משתמשים בבוחר קבצים כדי לאפשר למשתמש לבחור שם קובץ, בלי קשר להגדרה של filename או לקיומו.

  • url

    מחרוזת

    כתובת ה-URL להורדה.

DownloadQuery

מאפיינים

  • bytesReceived

    מספר אופציונלי

    מספר הבייטים שהתקבלו עד עכשיו מהמארח, בלי להתחשב בדחיסת הקובץ.

  • סכנה

    ‫DangerType אופציונלי

    בעמודה הזו מצוין אם ההורדה הזו נחשבת בטוחה או חשודה.

  • endTime

    מחרוזת אופציונלי

    השעה שבה ההורדה הסתיימה בפורמט ISO 8601.

  • endedAfter

    מחרוזת אופציונלי

    הגבלת התוצאות ל-DownloadItem שהסתיימו אחרי המילישנייה שצוינה בפורמט ISO 8601

  • endedBefore

    מחרוזת אופציונלי

    הגבלת התוצאות ל-DownloadItem שהסתיימו לפני המילישנייה שצוינה בפורמט ISO 8601.

  • error

    ‫InterruptReason אופציונלי

    למה ההורדה הופסקה.

  • קיים

    ‫boolean אופציונלי

    האם הקובץ שהורד קיים;

  • fileSize

    מספר אופציונלי

    מספר הבייטים בקובץ כולו אחרי הפעולה, או ‎-1 אם לא ידוע.

  • שם קובץ

    מחרוזת אופציונלי

    נתיב מקומי מוחלט.

  • filenameRegex

    מחרוזת אופציונלי

    מגביל את התוצאות ל-DownloadItem שערך filename שלו תואם לביטוי הרגולרי שצוין.

  • finalUrl

    מחרוזת אופציונלי

    ‫Chrome 54 ואילך

    כתובת URL אבסולוטית שממנה מתבצעת ההורדה, אחרי כל ההפניות האוטומטיות.

  • finalUrlRegex

    מחרוזת אופציונלי

    ‫Chrome 54 ואילך

    מגביל את התוצאות ל-DownloadItem שערך finalUrl שלו תואם לביטוי הרגולרי שצוין.

  • id [מזהה]

    מספר אופציונלי

    ה-id של DownloadItem שאותו רוצים לשאול.

  • הגבלה

    מספר אופציונלי

    המספר המקסימלי של DownloadItem תואמים שיוחזרו. ברירת המחדל היא 1,000. מגדירים את הערך כ-0 כדי לקבל את כל DownloadItem שתואמים. במאמר search מוסבר איך עוברים בין דפי התוצאות.

  • פנטומימה

    מחרוזת אופציונלי

    סוג ה-MIME של הקובץ.

  • orderBy

    string[] אופציונלי

    כדי למיין את תוצאות החיפוש, מגדירים את הרכיבים של המערך הזה כמאפיינים של DownloadItem. לדוגמה, ההגדרה orderBy=['startTime'] ממיינת את DownloadItem לפי שעת ההתחלה בסדר עולה. כדי לציין סדר יורד, מוסיפים מקף לפני שם המאפיין: ‎'-startTime'.

  • מושהה

    ‫boolean אופציונלי

    הערך הוא True אם ההורדה הפסיקה לקרוא נתונים מהמארח, אבל השאירה את החיבור פתוח.

  • שאילתה

    string[] אופציונלי

    מערך מונחי החיפוש הזה מגביל את התוצאות ל-DownloadItem שבהן filename או url או finalUrl מכילים את כל מונחי החיפוש שלא מתחילים במקף '-', ולא מכילים אף אחד ממונחי החיפוש שמתחילים במקף.

  • startTime

    מחרוזת אופציונלי

    השעה שבה ההורדה התחילה בפורמט ISO 8601.

  • startedAfter

    מחרוזת אופציונלי

    הגבלת התוצאות ל-DownloadItem שהתחילו אחרי הזמן שצוין במילישניות בפורמט ISO 8601.

  • startedBefore

    מחרוזת אופציונלי

    התוצאות מוגבלות ל-DownloadItem שהתחילו לפני הזמן שצוין במילישניות בפורמט ISO 8601.

  • הסמוי הסופי

    ‫State אופציונלי

    מציין אם ההורדה מתקדמת, הופסקה או הושלמה.

  • totalBytes

    מספר אופציונלי

    מספר הבייטים בקובץ כולו, בלי להתחשב בדחיסת הקובץ, או ‎-1 אם לא ידוע.

  • totalBytesGreater

    מספר אופציונלי

    התוצאות מוגבלות ל-DownloadItem שערך totalBytes שלהן גדול מהמספר השלם שצוין.

  • totalBytesLess

    מספר אופציונלי

    התוצאות מוגבלות ל-DownloadItem שערך totalBytes שלהן קטן מהמספר השלם שצוין.

  • url

    מחרוזת אופציונלי

    כתובת URL אבסולוטית שממנה התחילה ההורדה, לפני כל ההפניות האוטומטיות.

  • urlRegex

    מחרוזת אופציונלי

    מגביל את התוצאות ל-DownloadItem שערך url שלו תואם לביטוי הרגולרי שצוין.

FilenameConflictAction

uniquify

כדי למנוע כפילות, המחרוזת filename משתנה וכוללת מונה לפני סיומת שם הקובץ.

להחליף

הקובץ הקיים יוחלף בקובץ החדש.

פרומפט

תוצג למשתמש תיבת דו-שיח לבחירת קובץ.

ספירה

"uniquify"

‫'overwrite'

"prompt"

FilenameSuggestion

מאפיינים

  • conflictAction

    ‫FilenameConflictAction אופציונלי

    הפעולה שיש לבצע אם filename כבר קיים.

  • שם קובץ

    מחרוזת

    יעד חדש של DownloadItem,‏ DownloadItem.filename, כנתיב יחסי לספריית ההורדות שמוגדרת כברירת מחדל של המשתמש, שעשוי להכיל ספריות משנה. המערכת תתעלם מנתיבים מוחלטים, מנתיבים ריקים ומנתיבים שמכילים הפניות חוזרות (back-references) כמו '..'. המערכת מתעלמת מ-filename אם יש ממשקי listener של onDeterminingFilename שרשומים על ידי תוספים כלשהם.

GetFileIconOptions

מאפיינים

  • size

    מספר אופציונלי

    גודל הסמל שמוחזר. הסמל יהיה ריבועי עם מידות של size * size פיקסלים. גודל ברירת המחדל של הסמל הוא 32x32 פיקסלים, וזה גם הגודל המקסימלי. הגדלים הנתמכים היחידים הם 16 ו-32. אסור לציין גודל אחר.

HeaderNameValuePair

מאפיינים

  • שם

    מחרוזת

    השם של כותרת ה-HTTP.

  • ערך

    מחרוזת

    הערך של כותרת ה-HTTP.

HttpMethod

ספירה

‫GET

‫POST

InterruptReason

ספירה

‫"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"

‫"CRASH"

State

in_progress

ההורדה מקבלת כרגע נתונים מהשרת.

הופסקה

הייתה שגיאה שגרמה לניתוק החיבור למארח הקבצים.

complete

ההורדה הושלמה בהצלחה.

ספירה

‫"in_progress"

"interrupted"

‫complete

StringDelta

מאפיינים

  • current, קורנט

    מחרוזת אופציונלי

  • הקודם

    מחרוזת אופציונלי

UiOptions

‫Chrome 105 ואילך

מאפיינים

  • פעיל

    בוליאני

    מפעילים או משביתים את ממשק המשתמש של ההורדות.

Methods

acceptDanger()

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

הצגת בקשה למשתמש לאשר הורדה מסוכנת. אפשר לקרוא לפונקציה רק מהקשר גלוי (כרטיסייה, חלון או חלון קופץ של פעולת דף או פעולת דפדפן). לא מאשרת הורדות מסוכנות באופן אוטומטי. אם ההורדה מאושרת, מופעל אירוע onChanged, אחרת לא קורה כלום. אחרי שכל הנתונים נמשכים לקובץ זמני, וההורדה לא מסוכנת או שהסכנה אושרה, השם של הקובץ הזמני משתנה לשם של קובץ היעד, הערך של state משתנה ל-complete, והאירוע onChanged מופעל.

פרמטרים

  • downloadId

    number

    המזהה של DownloadItem.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    מחזירה Promise שמושלם כשתיבת הדו-שיח של אזהרת הסכנה נסגרת.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

cancel()

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

ביטול הורדה. כשמריצים את callback, ההורדה מבוטלת, מסתיימת, מופרעת או שהיא כבר לא קיימת.

פרמטרים

  • downloadId

    number

    המזהה של ההורדה שרוצים לבטל.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    מחזירה הבטחה (Promise) שמושלמת כשהבקשה לביטול מסתיימת.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

download()

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

הורדה של כתובת URL. אם כתובת ה-URL משתמשת בפרוטוקול HTTP[S], הבקשה תכלול את כל קובצי ה-Cookie שמוגדרים כרגע עבור שם המארח שלה. אם מציינים גם את filename וגם את saveAs, מוצגת תיבת הדו-שיח 'שמירה בשם' עם הערך שצוין ב-filename. אם ההורדה התחילה בהצלחה, הפונקציה callback תיקרא עם downloadId של DownloadItem החדש. אם הייתה שגיאה בהתחלת ההורדה, הפונקציה callback תיקרא עם downloadId=undefined והמחרוזת runtime.lastError תכיל תיאור. אין ערובה לכך שמחרוזות השגיאה יישארו תואמות לאחור בין גרסאות. אסור לתוספים לנתח אותו.

פרמטרים

  • options

    DownloadOptions

    מה אפשר להוריד ואיך.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (downloadId: number) => void

    • downloadId

      number

החזרות

  • Promise<number>

    ‫Chrome 96 ואילך

    מחזירה הבטחה שמושלמת עם המזהה של DownloadItem החדש.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

erase()

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

מחיקת התאמה ל-DownloadItem מההיסטוריה בלי למחוק את הקובץ שהורד. אירוע onErased יופעל לכל DownloadItem שתואם ל-query, ואז יתבצע קריאה ל-callback.

פרמטרים

  • שאילתה

    DownloadQuery

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (erasedIds: number[]) => void

    • erasedIds

      number[]

החזרות

  • Promise<number[]>

    ‫Chrome 96 ואילך

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

getFileIcon()

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

אחזור של סמל להורדה שצוינה. בהורדות חדשות, סמלי הקבצים זמינים אחרי קבלת האירוע onCreated. יכול להיות שהתמונה שמוחזרת על ידי הפונקציה הזו בזמן ההורדה תהיה שונה מהתמונה שמוחזרת אחרי שההורדה מסתיימת. אחזור הסמלים מתבצע על ידי שליחת שאילתה למערכת ההפעלה או לערכת הכלים הבסיסית, בהתאם לפלטפורמה. לכן, הסמל שיוחזר יהיה תלוי במספר גורמים, כולל מצב ההורדה, הפלטפורמה, סוגי הקבצים הרשומים והערכת העיצוב. אם לא ניתן לקבוע את סמל הקובץ, runtime.lastError יכיל הודעת שגיאה.

פרמטרים

  • downloadId

    number

    המזהה של ההורדה.

  • options

    ‫GetFileIconOptions אופציונלי

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (iconURL?: string) => void

    • iconURL

      מחרוזת אופציונלי

החזרות

  • Promise<string | undefined>

    ‫Chrome 96 ואילך

    מחזירה Promise שמוביל לכתובת URL של תמונה שמייצגת את ההורדה.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

open()

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

פותחת את הקובץ שהורד אם ההורדה DownloadItem הושלמה, אחרת מחזירה שגיאה דרך runtime.lastError. בשיטה הזו נדרשת ההרשאה "downloads.open" בנוסף להרשאה "downloads". האירוע onChanged מופעל כשהפריט נפתח בפעם הראשונה. אפשר לקרוא לשיטה הזו רק בתגובה לתנועה של המשתמש.

פרמטרים

  • downloadId

    number

    המזהה של הקובץ שהורד.

  • callback

    פונקציה אופציונלית

    ‫Chrome 123 ואילך

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 123 ואילך

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

pause()

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

משהים את ההורדה. אם הבקשה מצליחה, ההורדה מושהית. אחרת, runtime.lastError מכיל הודעת שגיאה. הבקשה תיכשל אם ההורדה לא פעילה.

פרמטרים

  • downloadId

    number

    המזהה של ההורדה שרוצים להשהות.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    הפונקציה מחזירה Promise שמושלם כשהבקשה להשהיה מסתיימת.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

removeFile()

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

אם הקובץ שהורדתם קיים והפעולה DownloadItem הושלמה, צריך להסיר את הקובץ. אחרת, צריך להחזיר שגיאה באמצעות runtime.lastError.

פרמטרים

  • downloadId

    number

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

resume()

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

להמשיך הורדה שהושהתה. אם הבקשה מצליחה, ההורדה מתבצעת ומושהית. אחרת, runtime.lastError מכיל הודעת שגיאה. הבקשה תיכשל אם ההורדה לא פעילה.

פרמטרים

  • downloadId

    number

    המזהה של ההורדה שרוצים להמשיך.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

    מחזירה Promise שמושלם כשהבקשה לחידוש מסתיימת.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

Promise 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
): Promise<DownloadItem[]>

מחפשים את DownloadItem. מגדירים את query לאובייקט הריק כדי לקבל את כל DownloadItem. כדי לקבל DownloadItem ספציפי, מגדירים רק את השדה id. כדי לעבור בין דפים של מספר גדול של פריטים, מגדירים את orderBy: ['-startTime'], את limit למספר הפריטים בכל דף ואת startedAfter לstartTime של הפריט האחרון מהדף האחרון.

פרמטרים

החזרות

  • Promise<DownloadItem[]>

    ‫Chrome 96 ואילך

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

setShelfEnabled()

הוצאה משימוש מאז Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
): void

במקום זאת, צריך להשתמש ב-setUiOptions.

ההגדרה הזו מאפשרת להפעיל או להשבית את המדף האפור בחלק התחתון של כל חלון שמשויך לפרופיל הדפדפן הנוכחי. המגש יושבת כל עוד לפחות תוסף אחד השבית אותו. הפעלת המדף בזמן שלפחות תוסף אחד אחר השבית אותו תחזיר שגיאה דרך runtime.lastError. נדרשת ההרשאה "downloads.shelf" בנוסף להרשאה "downloads".

פרמטרים

  • פעיל

    בוליאני

setUiOptions()

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

לשנות את ממשק המשתמש של ההורדה בכל חלון שמשויך לפרופיל הדפדפן הנוכחי. ממשק המשתמש להורדה יוסתר כל עוד לפחות תוסף אחד הגדיר את UiOptions.enabled כ-false. אם מגדירים את UiOptions.enabled ל-true בזמן שלפחות תוסף אחד אחר השבית אותו, תוחזר שגיאה דרך runtime.lastError. נדרשת ההרשאה "downloads.ui" בנוסף להרשאה "downloads".

פרמטרים

  • options

    UiOptions

    הוספת שינוי לממשק המשתמש של ההורדות.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    מחזירה Promise שמושלם כשהעדכון של ממשק המשתמש מסתיים.

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

show()

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

הצגת הקובץ שהורד בתיקייה שלו במנהל הקבצים.

פרמטרים

  • downloadId

    number

    המזהה של הקובץ שהורד.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

הצגת תיקיית ההורדות שמוגדרת כברירת מחדל במנהל קבצים.

אירועים

onChanged

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

כשמשתנה אחד מהמאפיינים של DownloadItem, למעט bytesReceived ו-estimatedEndTime, האירוע הזה מופעל עם downloadId ואובייקט שמכיל את המאפיינים שהשתנו.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (downloadDelta: DownloadDelta) => void

onCreated

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

האירוע הזה מופעל עם האובייקט DownloadItem כשההורדה מתחילה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

במהלך תהליך קביעת שם הקובץ, לסיומות תהיה אפשרות לבטל את הגדרת היעד DownloadItem.filename. כל תוסף יכול לרשום רק listener אחד לאירוע הזה. כל מאזין חייב לקרוא ל-suggest פעם אחת בדיוק, באופן סינכרוני או אסינכרוני. אם המאזין קורא ל-suggest באופן אסינכרוני, הוא חייב להחזיר true. אם הפונקציה listener לא קוראת ל-suggest באופן סינכרוני ולא מחזירה את true, המערכת תקרא ל-suggest באופן אוטומטי. הפונקציה DownloadItem לא תושלם עד שכל רכיבי ה-listener יקראו לפונקציה suggest. המאזינים יכולים להתקשר אל suggest בלי ארגומנטים כדי לאפשר להורדה להשתמש ב-downloadItem.filename כשם הקובץ שלה, או להעביר אובייקט suggestion אל suggest כדי לשנות את שם קובץ היעד. אם יותר מתוסף אחד מבטל את שם הקובץ, התוסף האחרון שהותקן והמאזין שלו מעביר אובייקט suggestion ל-suggest הוא זה שקובע. כדי למנוע בלבול לגבי התוסף שיפעל, המשתמשים לא צריכים להתקין תוספים שעלולים להתנגש. אם ההורדה מופעלת על ידי download ושם קובץ היעד ידוע לפני שסוג ה-MIME ושם הקובץ הזמני נקבעו, מעבירים את filename אל download במקום זאת.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

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

onErased

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

מופעל עם downloadId כשמורידים משהו מההיסטוריה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (downloadId: number) => void

    • downloadId

      number