browser.downloads

תיאור

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

הרשאות

downloads

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

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

דוגמאות

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

סוגים

BooleanDelta

מאפיינים

  • current, קורנט

    בוליאני אופציונלי

  • הקודם

    בוליאני אופציונלי

DangerType

טיפוסים בני מנייה (enum)

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

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

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

"uncommon"
כתובת ה-URL של ההורדה לא משמשת בדרך כלל להורדה ועלולה להיות מסוכנת.

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

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

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

"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 ואילך browser.* ‎ מגרסה 148 של Chrome

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

  • id [מזהה]

    number

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

  • פנטומימה

    StringDelta אופציונלי

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

  • מושהה

    ‫BooleanDelta אופציונלי

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

  • startTime

    StringDelta אופציונלי

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

  • מדינה (State)

    StringDelta אופציונלי

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

  • totalBytes

    ‫DoubleDelta אופציונלי

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

  • url

    StringDelta אופציונלי

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

DownloadItem

מאפיינים

  • byExtensionId

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

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

  • byExtensionName

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

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

  • bytesReceived

    number

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

  • canResume

    בוליאני

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

  • סכנה

    DangerType

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

  • endTime

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

    השעה שבה ההורדה הסתיימה, בפורמט ISO 8601. אפשר להעביר ישירות ל-Date constructor: ‏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. אפשר להעביר ישירות ל-Date constructor: ‏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 ואילך browser.* ‎ מגרסה 148 של Chrome

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

  • id [מזהה]

    number

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

  • גלישה בסתר

    בוליאני

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

  • פנטומימה

    מחרוזת

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

  • מושהה

    בוליאני

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

  • גורם מפנה

    מחרוזת

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

  • startTime

    מחרוזת

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

  • מדינה (State)

    מדינה

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

  • totalBytes

    number

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

  • url

    מחרוזת

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

DownloadOptions

מאפיינים

  • גוף

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

    גוף הפוסט.

  • conflictAction

    FilenameConflictAction אופציונלי

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

  • שם קובץ

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

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

  • כותרות

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

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

  • method

    ‫HttpMethod אופציונלי

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

  • saveAs

    בוליאני אופציונלי

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

  • url

    מחרוזת

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

DownloadQuery

מאפיינים

  • bytesReceived

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

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

  • סכנה

    ‫DangerType אופציונלי

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

  • endTime

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

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

  • endedAfter

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

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

  • endedBefore

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

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

  • error

    ‫InterruptReason אופציונלי

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

  • קיים

    בוליאני אופציונלי

    אם הקובץ שהורדתם קיים.

  • fileSize

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

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

  • שם קובץ

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

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

  • filenameRegex

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

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

  • finalUrl

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

    ‫Chrome 54 ואילך browser.* ‎ מגרסה 148 של Chrome

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

  • finalUrlRegex

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

    ‫Chrome 54 ואילך browser.* ‎ מגרסה 148 של Chrome

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

  • id [מזהה]

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

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

  • הגבלה

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

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

  • פנטומימה

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

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

  • orderBy

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

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

  • מושהה

    בוליאני אופציונלי

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

  • שאילתה

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

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

  • startTime

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

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

  • startedAfter

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

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

  • startedBefore

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

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

  • מדינה (State)

    ‫State (מדינה) אופציונלי

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

  • totalBytes

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

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

  • totalBytesGreater

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

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

  • totalBytesLess

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

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

  • url

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

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

  • urlRegex

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

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

FilenameConflictAction

uniquify

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

להחליף

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

פרומפט

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

טיפוסים בני מנייה (enum)

"uniquify"

"overwrite"

"prompt"

FilenameSuggestion

מאפיינים

  • conflictAction

    FilenameConflictAction אופציונלי

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

  • שם קובץ

    מחרוזת

    היעד החדש של DownloadItem, DownloadItem.filename, כנתיב יחסי לספריית ההורדות שמוגדרת כברירת מחדל אצל המשתמש, שעשוי להכיל ספריות משנה. המערכת תתעלם מנתיבים מוחלטים, מנתיבים ריקים ומנתיבים שמכילים הפניות לאחור "..". המערכת מתעלמת מ-filename אם יש מאזינים מסוג onDeterminingFilename שרשומים על ידי תוספים כלשהם.

GetFileIconOptions

מאפיינים

  • size

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

    גודל הסמל שמוחזר בפיקסלים שלא תלויים בצפיפות (DIP). הערך חייב להיות 16 או 32 (ברירת המחדל היא 32). במסכים עם DPI גבוה, התמונה שמוחזרת משתנה בהתאם לגורם לקביעת קנה המידה של המכשיר (למשל, 64x64 פיקסלים לגודל 32 במסך 2x). קריאות מקובצי שירות (Service Workers) שפועלים ברקע מוגדרות כברירת מחדל לקנה מידה של 1x.

HeaderNameValuePair

מאפיינים

  • שם

    מחרוזת

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

  • ערך

    מחרוזת

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

HttpMethod

טיפוסים בני מנייה (enum)

"GET"

"POST"

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"

"CRASH"

State

in_progress

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

ההורדה הופסקה

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

complete

ההורדה הסתיימה.

טיפוסים בני מנייה (enum)

"in_progress"

"interrupted"

"complete"

StringDelta

מאפיינים

  • current, קורנט

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

  • הקודם

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

UiOptions

‫Chrome 105 ואילך ‫browser.* ‎ מ-Chrome 148

מאפיינים

  • פעיל

    בוליאני

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

Methods

acceptDanger()

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

    הפונקציה מחזירה Promise שמתבצעת כשתיבת הדו-שיח של ההנחיה המסוכנת נסגרת.

cancel()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

download()

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

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

פרמטרים

החזרות

  • Promise<number>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

    מחזירה Promise שמתקבל עם המזהה של DownloadItem החדש.

erase()

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

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

פרמטרים

החזרות

  • Promise<number[]>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

getFileIcon()

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

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

פרמטרים

  • downloadId

    number

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

  • אפשרויות

    ‫GetFileIconOptions אופציונלי

החזרות

  • Promise<string | undefined>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

open()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 123 ואילך ‫browser.* ‎ החל מ-Chrome 148

pause()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

removeFile()

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

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

פרמטרים

  • downloadId

    number

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

resume()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

browser.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

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

פרמטרים

החזרות

  • Promise<DownloadItem[]>

    ‫Chrome 96 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

setShelfEnabled()

הוצאה משימוש בגרסה Chrome 117
browser.downloads.setShelfEnabled(
  enabled: boolean,
): void

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

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

פרמטרים

  • פעיל

    בוליאני

setUiOptions()

‫Chrome 105 ואילך ‫browser.* ‎ מ-Chrome 148 
browser.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

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

פרמטרים

  • אפשרויות

    UiOptions

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

החזרות

  • Promise<void>

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

show()

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

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

פרמטרים

  • downloadId

    number

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

showDefaultFolder()

browser.downloads.showDefaultFolder(): void

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

אירועים

onChanged

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

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

פרמטרים

  • callback

    פונקציה

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

    (downloadDelta: DownloadDelta) => void

onCreated

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

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

פרמטרים

  • callback

    פונקציה

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

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

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

פרמטרים

  • callback

    פונקציה

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

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

onErased

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

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

פרמטרים

  • callback

    פונקציה

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

    (downloadId: number) => void

    • downloadId

      number