chrome.downloads

תיאור

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

הרשאות

downloads

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

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

דוגמאות

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

סוגים

BooleanDelta

מאפיינים

  • current, קורנט

    ‫boolean אופציונלי

  • הקודם

    ‫boolean אופציונלי

DangerType

קובץ

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

כתובת אתר

כתובת ה-URL של ההורדה מוכרת ככתובת זדונית.

תוכן

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

לא נפוץ

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

מארח

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

לא רצוי

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

בטיחות

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

התקבל

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

Enum

"file"

"url"

‫"content"

"uncommon"

"host"

‫"unwanted"

"safe"

‫'accepted'

‫"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

‫"passwordProtected"

‫"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

‫"deepScannedFailed"

"deepScannedSafe"

‫"deepScannedOpenedDangerous"

‫"promptForScanning"

"promptForLocalPasswordScanning"

‎"accountCompromise"‎

‫"blockedScanFailed"

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, אם יש כזה.

  • כתובת אתר

    ‫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 המוחלטת שממנה התחילה ההורדה, לפני הפניות אוטומטיות.

DownloadOptions

מאפיינים

  • body

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

    גוף הפוסט.

  • conflictAction

    ‫FilenameConflictAction אופציונלי

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

  • שם קובץ

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

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

  • headers

    ‫HeaderNameValuePair[] optional

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

  • method

    ‫HttpMethod אופציונלי

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

  • saveAs

    ‫boolean אופציונלי

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

  • כתובת אתר

    מחרוזת

    כתובת ה-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.

  • הסמוי הסופי

    מדינה אופציונלי

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

  • totalBytes

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

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

  • totalBytesGreater

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

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

  • totalBytesLess

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

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

  • כתובת אתר

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

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

  • urlRegex

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

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

FilenameConflictAction

הפיכה לייחודי

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

להחליף

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

הנחיה

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

Enum

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

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

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

הופסקה

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

בוצעו

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

Enum

‎"in_progress"

"interrupted"

‫'complete'

StringDelta

מאפיינים

  • current, קורנט

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

  • הקודם

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

UiOptions

‫Chrome 105 ואילך

מאפיינים

  • פעיל

    בוליאני

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

Methods

acceptDanger()

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

cancel()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

download()

chrome.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 ואילך

erase()

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

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

פרמטרים

החזרות

  • Promise<number[]>

    ‫Chrome 96 ואילך

getFileIcon()

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

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

פרמטרים

  • downloadId

    number

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

  • options

    ‫GetFileIconOptions אופציונלי

החזרות

  • Promise<string | undefined>

    ‫Chrome 96 ואילך

open()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 123 ואילך

pause()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

removeFile()

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

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

פרמטרים

  • downloadId

    number

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך

resume()

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

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

פרמטרים

  • downloadId

    number

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

החזרות

  • Promise<void>

    ‫Chrome 96 ואילך 
chrome.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

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

פרמטרים

החזרות

setShelfEnabled()

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

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

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

פרמטרים

  • פעיל

    בוליאני

setUiOptions()

‫Chrome 105 ואילך 
chrome.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

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

פרמטרים

  • options

    UiOptions

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

החזרות

  • Promise<void>

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. אם המאזין לא קורא ל-suggest באופן סינכרוני ולא מחזיר את true, אז המערכת תקרא ל-suggest באופן אוטומטי. השיחה בDownloadItem לא תסתיים עד שכל המאזינים יתקשרו ל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