תיאור
שימוש ב-API של chrome.downloads
כדי להפעיל הורדות, לעקוב אחריהן, לשנות אותן ולחפש אותן באופן פרוגרמטי.
הרשאות
downloads
כדי להשתמש ב-API הזה, צריך להצהיר על ההרשאה "downloads"
במניפסט התוסף.
{
"name": "My extension",
...
"permissions": [
"downloads"
],
}
דוגמאות
דוגמאות פשוטות לשימוש ב-API של chrome.downloads
זמינות בקטע examples/api/downloads
לדוגמאות נוספות ולעזרה בהצגת קוד המקור, ראו דוגמאות.
סוגים
BooleanDelta
מאפיינים
-
current, קורנט
ערך בוליאני אופציונלי
-
הקודם
ערך בוליאני אופציונלי
DangerType
קובץ
שם הקובץ של ההורדה חשוד.
כתובת אתר
ידוע שכתובת ה-URL של ההורדה זדונית.
תוכן
ידוע שהקובץ שהורדתם הוא זדוני.
לא נפוץ
בדרך כלל לא מתבצעת הורדה של כתובת ה-URL של ההורדה, והיא עלולה להיות מסוכנת.
מארח
ההורדה הגיעה ממארח שידוע שמפיץ קבצים בינאריים זדוניים, וסביר להניח שהוא מסוכן.
לא רצוי
יכול להיות שההורדה לא רצויה או לא בטוחה. לדוגמה עשויים לבצע שינויים בהגדרות הדפדפן או המחשב.
בטיחות
ההורדה לא מהווה סכנה ידועה למחשב המשתמש.
התקבל
המשתמש אישר את ההורדה המסוכנת.
Enum
"file"
"url"
"content"
"uncommon"
"host"
"לא רצוי"
"בטוח"
"מותר"
"allowlistedByPolicy"
"asyncScanning"
"asyncLocalPasswordScanning"
"passwordProtected"
"blockedTooL"
"sensitiveContentWarning"
"sensitiveContentBlock"
"deepScannedFailed"
"deepScannedSafe"
"deepScannedOpened שמאל "
"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 אם ההורדה מתבצעת והיא מושהית, או אם ההורדה הופסקה ואפשר להמשיך אותה מהמקום שבו היא הופסקה.
-
סכנה
בעמודה הזו מצוין אם ההורדה נחשבת בטוחה או חשודה.
-
endTime
מחרוזת אופציונלי
השעה שבה ההורדה הסתיימה בפורמט ISO 8601. ניתן להעביר ישירות אל 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. ניתן להעביר ישירות אל 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+כתובת ה-URL המוחלטת שממנה מתבצעת ההורדה הזו, אחרי כל ההפניות האוטומטיות.
-
id [מזהה]
number
מזהה קבוע בכל הסשנים בדפדפן.
-
גלישה פרטית
בוליאני
הערך יהיה False אם ההורדה הזו מתועדת בהיסטוריה, אם היא לא מתועדת.
-
פנטומימה
מחרוזת
סוג ה-MIME של הקובץ.
-
מושהה
בוליאני
הערך הוא True אם ההורדה הפסיקה לקרוא נתונים מהמארח, אבל החיבור נשאר פתוח.
-
גורם מפנה
מחרוזת
כתובת URL מוחלטת.
-
startTime
מחרוזת
השעה שבה ההורדה התחילה בפורמט ISO 8601. ניתן להעביר ישירות אל constructor של התאריך:
chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})
-
הסמוי הסופי
מציין אם ההורדה מתקדמת, נקטעת או הושלמה.
-
totalBytes
number
מספר הבייטים בקובץ כולו, בלי להתחשב בדחיסת הקובץ או 1- אם לא ידוע.
-
כתובת אתר
מחרוזת
כתובת ה-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 להורדה.
DownloadQuery
מאפיינים
-
bytesReceived
מספר אופציונלי
מספר הבייטים שהתקבלו עד עכשיו מהמארח, בלי להתחשב בדחיסת הקובץ.
-
סכנה
DangerType אופציונלי
בעמודה הזו מצוין אם ההורדה נחשבת בטוחה או חשודה.
-
endTime
מחרוזת אופציונלי
השעה שבה ההורדה הסתיימה בפורמט ISO 8601.
-
endedAfter
מחרוזת אופציונלי
הגבלת התוצאות ל-
DownloadItem
שהסתיימו אחרי אלפיות השנייה בפורמט ISO 8601 -
endedBefore
מחרוזת אופציונלי
הגבלת התוצאות ל-
DownloadItem
שהסתיימו לפני ה-ms הנתון בפורמט 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
שהתחילו לפני ה-ms הנתון בפורמט ISO 8601. -
הסמוי הסופי
מדינה (State) אופציונלי
מציין אם ההורדה מתקדמת, נקטעת או הושלמה.
-
totalBytes
מספר אופציונלי
מספר הבייטים בקובץ כולו, בלי להתחשב בדחיסת הקובץ או 1- אם לא ידוע.
-
totalBytesGreater
מספר אופציונלי
מגביל את התוצאות לערך
DownloadItem
שה-totalBytes
שלו גדול מהמספר השלם הנתון. -
totalBytesLess
מספר אופציונלי
מגביל את התוצאות לפונקציה
DownloadItem
שהtotalBytes
שלה קטן מהמספר השלם הנתון. -
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL המוחלטת שממנה התחילה ההורדה, לפני הפניות אוטומטיות.
-
urlRegex
מחרוזת אופציונלי
מגביל את התוצאות לערך
DownloadItem
שה-url
שלו תואם לביטוי הרגולרי הנתון.
FilenameConflictAction
איחוד
כדי למנוע כפילויות, הערך filename
משתנה כך שיכלול מונה לפני סיומת שם הקובץ.
להחליף
הקובץ הקיים יוחלף בקובץ החדש.
הצעה לפעולה
למשתמש תוצג תיבת דו-שיח לבחירת קבצים.
Enum
"uniquify"
"overwrite"
"הודעה"
FilenameSuggestion
מאפיינים
-
conflictAction
FilenameConflictAction אופציונלי
הפעולה שצריך לבצע אם
filename
כבר קיים. -
שם קובץ
מחרוזת
היעד החדש של
DownloadItem
DownloadItem.filename
, כנתיב יחסי לספריית ההורדות שמוגדרת כברירת מחדל של המשתמש, שאולי מכיל ספריות משנה. נתיבים מוחלטים, נתיבים ריקים ונתיבים שמכילים הפניות אחורה "." המערכת תתעלם ממנו. אם יש מאזינים שלonDeterminingFilename
שרשומים בתוספים, המערכת מתעלמת מ-filename
.
GetFileIconOptions
מאפיינים
-
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_proxy_DOWN"
"NETWORK_INVALID_REQUEST"
"server_FAILED"
"proxy_NO_RANGE"
"server_BAD_CONTENT"
"server_UNAUTHORIZED"
"server_CERT_PROBLEM"
"server_FORBIDDEN"
"proxy_UNREACHABLE"
"SERVER_CONTENT_LENGTH_MISMATCH"
"SERVER_CROSS_ORIGIN_REDIRECT"
"USER_CANCELED"
"USER_SHUTDOWN"
"קריסה"
State
in_progress
קובץ ההורדה מקבל כרגע נתונים מהשרת.
נקטע
שגיאה ניתקה את החיבור עם מארח הקובץ.
בוצעו
ההורדה הושלמה בהצלחה.
Enum
"in_progress"
"הפרעה"
"complete"
StringDelta
מאפיינים
-
current, קורנט
מחרוזת אופציונלי
-
הקודם
מחרוזת אופציונלי
UiOptions
מאפיינים
-
פעיל
בוליאני
להפעיל או להשבית את ממשק המשתמש של ההורדות.
שיטות
acceptDanger()
chrome.downloads.acceptDanger(
downloadId: number,
callback?: function,
)
צריך לבקש מהמשתמש לאשר הורדה מסוכנת. ניתן לקרוא לקריאת רק מהקשר גלוי (כרטיסייה, חלון או חלון קופץ של פעולה בדף/דפדפן). לא מאשרים באופן אוטומטי הורדות מסוכנות. אם ההורדה תאושר, האירוע onChanged
יופעל. אחרת, לא יקרה כלום. כשמאחזרים את כל הנתונים לקובץ זמני וכשההורדה לא מסוכנת או אם הסכנה אושרה, השם של הקובץ הזמני ישתנה לשם של קובץ היעד, state
ישתנה ל-complete ו-onChanged
יופעל.
פרמטרים
-
downloadId
number
המזהה של
DownloadItem
. -
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
cancel()
chrome.downloads.cancel(
downloadId: number,
callback?: function,
)
מבטלים הורדה. כאשר callback
מופעל, ההורדה מבוטלת, מסתיימת, מופסקת או לא קיימת יותר.
פרמטרים
-
downloadId
number
המזהה של ההורדה שרוצים לבטל.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
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
יכיל מחרוזת תיאורית. לא בטוח שמחרוזות השגיאה יישארו תואמות לאחור בין הגרסאות. אסור לתוספים לנתח אותו.
פרמטרים
-
אפשרויות
מה להוריד ואיך.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(downloadId: number) => void
-
downloadId
number
-
החזרות
-
Promise<number>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
erase()
chrome.downloads.erase(
query: DownloadQuery,
callback?: function,
)
מחיקת DownloadItem
תואם מההיסטוריה בלי למחוק את הקובץ שהורד. אירוע onErased
יופעל לכל DownloadItem
שתואם ל-query
, ולאחר מכן תתבצע קריאה ל-callback
.
פרמטרים
-
שאילתה
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(erasedIds: number[]) => void
-
erasedIds
מספר[]
-
החזרות
-
התחייבות<number[]>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
getFileIcon()
chrome.downloads.getFileIcon(
downloadId: number,
options?: GetFileIconOptions,
callback?: function,
)
אחזור סמל להורדה שצוינה. סמלי הקבצים של הורדות חדשות יהיו זמינים אחרי שתקבלו את האירוע onCreated
. התמונה שהוחזרה על ידי הפונקציה הזו בזמן שההורדה מתבצעת עשויה להיות שונה מהתמונה שהוחזרה לאחר השלמת ההורדה. אחזור הסמלים מתבצע על ידי שליחת שאילתה למערכת ההפעלה או לערכת הכלים הבסיסית, בהתאם לפלטפורמה. לכן, הסמל שיוחזר תלוי בכמה גורמים, כולל מצב ההורדה, הפלטפורמה, סוגי הקבצים הרשומים והעיצוב החזותי. אם אי אפשר לזהות סמל של קובץ, תוצג הודעת שגיאה בשדה runtime.lastError
.
פרמטרים
-
downloadId
number
המזהה של ההורדה.
-
אפשרויות
GetFileIconOptions אופציונלי
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(iconURL?: string) => void
-
iconURL
מחרוזת אופציונלי
-
החזרות
-
Promise<string | לא מוגדר>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
open()
chrome.downloads.open(
downloadId: number,
callback?: function,
)
פתיחת הקובץ שהורדתם עכשיו אם השדה DownloadItem
הושלם. אחרת, מחזירה שגיאה דרך runtime.lastError
. לשיטה הזו נדרשת ההרשאה "downloads.open"
בנוסף להרשאה "downloads"
. אירוע onChanged
מופעל כשהפריט נפתח בפעם הראשונה. ניתן לקרוא לשיטה הזו רק בתגובה לתנועת משתמש.
פרמטרים
-
downloadId
number
המזהה של הקובץ שהורד.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
Chrome 123 ואילךהפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome 123 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
pause()
chrome.downloads.pause(
downloadId: number,
callback?: function,
)
להשהות את ההורדה. אם הבקשה בוצעה בהצלחה, ההורדה במצב מושהה. אחרת, runtime.lastError
מכיל הודעת שגיאה. אם ההורדה לא פעילה, הבקשה תיכשל.
פרמטרים
-
downloadId
number
המזהה של ההורדה שרוצים להשהות.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
removeFile()
chrome.downloads.removeFile(
downloadId: number,
callback?: function,
)
מסירים את הקובץ שהורד אם הוא קיים, ואם השדה DownloadItem
הושלם. אחרת, הפונקציה תחזיר שגיאה דרך runtime.lastError
.
פרמטרים
-
downloadId
number
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
resume()
chrome.downloads.resume(
downloadId: number,
callback?: function,
)
להמשיך הורדה שהושהתה. אם הבקשה בוצעה בהצלחה, ההורדה מתבצעת וההשהיה בוטלה. אחרת, runtime.lastError
מכיל הודעת שגיאה. אם ההורדה לא פעילה, הבקשה תיכשל.
פרמטרים
-
downloadId
number
המזהה של ההורדה כדי להמשיך.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
search()
chrome.downloads.search(
query: DownloadQuery,
callback?: function,
)
מוצאים את DownloadItem
. מגדירים את query
לאובייקט הריק כדי לקבל את כל הערכים של DownloadItem
. כדי לקבל DownloadItem
ספציפי, צריך להגדיר רק את השדה id
. כדי לעבור בין מספר גדול של פריטים, צריך להגדיר את orderBy: ['-startTime']
, להגדיר את limit
למספר הפריטים בכל דף ולהגדיר את startedAfter
לערך startTime
של הפריט האחרון בדף האחרון.
פרמטרים
-
שאילתה
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(results: DownloadItem[]) => void
-
תוצאות
-
החזרות
-
Promise<DownloadItem[]>
Chrome מגרסה 96 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
setShelfEnabled()
chrome.downloads.setShelfEnabled(
enabled: boolean,
)
במקום זאת, אתם צריכים להשתמש ב-setUiOptions
.
הפעלה או השבתה של המדף האפור בחלק התחתון של כל חלון שמשויך לפרופיל הדפדפן הנוכחי. המדף יושבת כל עוד תוסף אחד לפחות השבית אותו. הפעלת המדף בזמן שלפחות תוסף אחד אחר מושבת, תחזיר שגיאה עד runtime.lastError
. נדרשת ההרשאה "downloads.shelf"
בנוסף להרשאה "downloads"
.
פרמטרים
-
פעיל
בוליאני
setUiOptions()
chrome.downloads.setUiOptions(
options: UiOptions,
callback?: function,
)
שינוי ממשק המשתמש של ההורדות של כל חלון שמשויך לפרופיל הדפדפן הנוכחי. כל עוד לפחות תוסף אחד מגדיר את UiOptions.enabled
כ-False, ממשק המשתמש של ההורדות יוסתר. אם הערך של UiOptions.enabled
הוא True, לפחות עוד תוסף אחד מושבת, תוצג הודעת שגיאה עד runtime.lastError
. נדרשת ההרשאה "downloads.ui"
בנוסף להרשאה "downloads"
.
פרמטרים
-
אפשרויות
כוללים שינוי בממשק המשתמש של ההורדות.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.
show()
chrome.downloads.show(
downloadId: number,
)
להציג את הקובץ שהורדתם בתיקייה שלו במנהל הקבצים.
פרמטרים
-
downloadId
number
המזהה של הקובץ שהורד.
showDefaultFolder()
chrome.downloads.showDefaultFolder()
הצגת תיקיית ההורדות שמוגדרת כברירת מחדל במנהל הקבצים.
אירועים
onChanged
chrome.downloads.onChanged.addListener(
callback: function,
)
בכל פעם שמשתנה אחד מהמאפיינים של DownloadItem
, מלבד bytesReceived
ו-estimatedEndTime
, האירוע הזה מופעל עם downloadId
ועם אובייקט שמכיל את המאפיינים שהשתנו.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(downloadDelta: DownloadDelta) => void
-
downloadDelta
-
onCreated
chrome.downloads.onCreated.addListener(
callback: function,
)
האירוע הזה מופעל עם האובייקט DownloadItem
כשמתחילה הורדה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(downloadItem: DownloadItem) => void
-
downloadItem
-
onDeterminingFilename
chrome.downloads.onDeterminingFilename.addListener(
callback: function,
)
בתהליך בחירת שם הקובץ, תינתן לתוספים הזדמנות לבטל את היעד DownloadItem.filename
. כל תוסף לא יכול לרשום יותר ממאזינים אחד לאירוע הזה. כל מאזינים חייבים לקרוא ל-suggest
פעם אחת בדיוק, באופן סינכרוני או אסינכרוני. אם המאזינים קוראים ל-suggest
באופן אסינכרוני, הוא צריך להחזיר true
. אם ה-listener לא קורא ל-suggest
באופן סינכרוני ולא מחזיר true
, תתבצע קריאה אוטומטית אל suggest
. הפעולה של DownloadItem
תושלם רק אחרי שכל המאזינים יקראו suggest
. מאזינים יכולים לקרוא לפונקציה suggest
ללא ארגומנטים כדי לאפשר להורדה להשתמש ב-downloadItem.filename
בתור שם הקובץ, או להעביר אובייקט suggestion
אל suggest
כדי לשנות את שם קובץ היעד. אם יותר מתוסף אחד מבטל את שם הקובץ, התוסף האחרון שמותקן שהמאזין שלו מעביר אובייקט suggestion
אל suggest
ינצח. כדי למנוע בלבול בנוגע לתוסף שינצח, מומלץ לא להתקין תוספים שעשויים להתנגש. אם ההורדה הופעלה על ידי download
ושם קובץ היעד ידוע לפני קביעת סוג ה-MIME ושם הקובץ הטנטטיבי, מעבירים את filename
אל download
במקום זאת.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(downloadItem: DownloadItem, suggest: function) => void
-
downloadItem
-
להציע
פונקציה
הפרמטר
suggest
נראה כך:(suggestion?: FilenameSuggestion) => void
-
הצעה מ-Android
FilenameSuggestion אופציונלי
-
-
onErased
chrome.downloads.onErased.addListener(
callback: function,
)
מופעלת באמצעות downloadId
כשההורדה נמחקת מההיסטוריה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(downloadId: number) => void
-
downloadId
number
-