chrome.downloads

תיאור

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

הרשאות

downloads

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

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

דוגמאות

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

סוגים

BooleanDelta

תכונות

• current, קורנט

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

• הקודם

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

DangerType

קובץ

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

כתובת אתר

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

רווחי

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

לא נפוץ

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

מארח

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

לא רצוי

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

בטיחות

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

התקבל

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

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

"url"

"asyncLocalPasswordScanning"

"passwordProtected"

"sensitiveContentBlock"

"promptForScanning"

"promptForLocalPasswordScanning"

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

  מספר

  ה-id של DownloadItem שהשתנה.

• פנטומימה

  StringDelta אופציונלי

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

• מושהה

  BooleanDelta אופציונלי

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

• startTime

  StringDelta אופציונלי

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

• state

  StringDelta אופציונלי

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

• totalBytes

  DoubleDelta אופציונלי

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

• כתובת אתר

  StringDelta אופציונלי

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

DownloadItem

תכונות

• byExtensionId

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

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

• byExtensionName

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

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

• bytesReceived

  מספר

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

• canResume

  boolean

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

• סכנה

  DangerType

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

• endTime

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

  השעה שבה ההורדה הסתיימה בפורמט ISO 8601. ניתן להעביר ישירות אל בונה התאריכים: 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. ניתן להעביר ישירות אל בונה התאריכים: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

• קיים

  boolean

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

• fileSize

  מספר

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

• שם קובץ

  מחרוזת

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

• finalUrl

  מחרוזת

  Chrome בגרסה 54 ומעלה

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

• id

  מספר

  מזהה שקבוע בכל סשנים בדפדפן.

• גלישה פרטית

  boolean

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

• פנטומימה

  מחרוזת

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

• מושהה

  boolean

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

• referrer

  מחרוזת

  כתובת URL מוחלטת.

• startTime

  מחרוזת

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

• state

  מדינה (State)

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

• totalBytes

  מספר

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

• כתובת אתר

  מחרוזת

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

DownloadOptions

תכונות

• body

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

  גוף הפוסט.

• conflictAction

  FilenameConflictAction אופציונלי

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

• שם קובץ

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

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

• headers

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

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

• method

  HttpMethod אופציונלי

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

• saveAs

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

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

• כתובת אתר

  מחרוזת

  כתובת ה-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 ומעלה

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

• finalUrlRegex

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

  Chrome בגרסה 54 ומעלה

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

• urlRegex

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

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

FilenameConflictAction

להשתמש באופן אחיד

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

להחליף

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

הצעה לפעולה

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

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

FilenameSuggestion

תכונות

• conflictAction

  FilenameConflictAction אופציונלי

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

• שם קובץ

  מחרוזת

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

GetFileIconOptions

תכונות

• size

   אופציונלי

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

HeaderNameValuePair

תכונות

• name

  מחרוזת

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

• value

  מחרוזת

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

HttpMethod

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

"GET"

"POST"

InterruptReason

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

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

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

"NETWORK_SERVER_DOWN"

"NETWORK_INVALID_REQUEST"

"SERVER_FAILED"

"USER_CANCELED"

"USER_SHUTDOWN"

"CRASH"

State

in_progress

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

הפרעה

שגיאה ניתקה את החיבור עם מארח הקובץ.

בוצעו

ההורדה הסתיימה בהצלחה.

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

"in_progress"

StringDelta

תכונות

• current, קורנט

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

• הקודם

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

UiOptions

Chrome מגרסה 105 ואילך

תכונות

• פעיל

  boolean

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

שיטות

acceptDanger()

הבטחה

chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

  המזהה של DownloadItem.

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

cancel()

הבטחה

chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

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

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

download()

הבטחה

chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

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

פרמטרים

• אפשרויות

  DownloadOptions

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

• קריאה חוזרת (callback)

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

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

  (downloadId: number)=>void

  • downloadId

    מספר

החזרות

• הבטחה<number>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

erase()

הבטחה

chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
)

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

פרמטרים

• שאילתה

  DownloadQuery

• קריאה חוזרת (callback)

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

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

  (erasedIds: number[])=>void

  • erasedIds

    מספר[]

החזרות

• הבטחה<מספר[]>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

getFileIcon()

הבטחה

chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

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

• אפשרויות

  GetFileIconOptions אופציונלי

• קריאה חוזרת (callback)

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

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

  (iconURL?: string)=>void

  • iconURL

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

החזרות

• הבטחה<string|undefined>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

open()

הבטחה

chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

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

• קריאה חוזרת (callback)

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

  Chrome מגרסה 123 ואילך

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

  ()=>void

החזרות

• Promise<void>

  Chrome מגרסה 123 ואילך

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

pause()

הבטחה

chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

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

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

removeFile()

הבטחה

chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

resume()

הבטחה

chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

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

פרמטרים

• downloadId

  מספר

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

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

search()

הבטחה

chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

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

פרמטרים

• שאילתה

  DownloadQuery

• קריאה חוזרת (callback)

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

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

  (results: DownloadItem[])=>void

  • תוצאות

    DownloadItem[]

החזרות

• Promise<DownloadItem[]>

  Chrome 96 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

setShelfEnabled()

הוצא משימוש מאז Chrome 117

chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

במקומו צריך להשתמש ב-setUiOptions.

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

פרמטרים

• פעיל

  boolean

setUiOptions()

Promise Chrome 105 ואילך

chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

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

פרמטרים

• אפשרויות

  UiOptions

  הזינו שינוי בממשק המשתמש של ההורדות.

• קריאה חוזרת (callback)

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

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

  ()=>void

החזרות

• Promise<void>

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

show()

chrome.downloads.show(
  downloadId: number,
)

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

פרמטרים

• downloadId

  מספר

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

showDefaultFolder()

chrome.downloads.showDefaultFolder()

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

אירועים

onChanged

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

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

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

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

  (downloadDelta: DownloadDelta)=>void

  • downloadDelta

    DownloadDelta

onCreated

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

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

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

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

  (downloadItem: DownloadItem)=>void

  • downloadItem

    DownloadItem

onDeterminingFilename

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

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

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

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

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

  • downloadItem

    DownloadItem

  • הצעה

    פונקציה

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

    (suggestion?: FilenameSuggestion)=>void

    • הצעה מ-Android

      FilenameSuggestion אופציונלי

onErased

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

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

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

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

  (downloadId: number)=>void

  • downloadId

    מספר