תיאור
ל-API של chrome.extension
יש כלי תחזוקה שיכולים לשמש כל דף תוסף. היא כוללת תמיכה בהחלפת הודעות בין תוסף לבין הסקריפטים של התוכן שלו או בין תוספים, כפי שמתואר בפירוט במאמר העברת הודעות.
סוגים
ViewType
הסוג של תצוגת התוספים.
טיפוסים בני מנייה (enum)
תכונות
inIncognitoContext
True לגבי סקריפטים של תוכן הפועלים בתוך כרטיסיות פרטיות, ועבור דפי תוספים הפועלים בתהליך פרטי. האפשרות השנייה חלה רק על תוספים עם 'split' private_behavior.
סוג
boolean
lastError
יש להשתמש ב-runtime.lastError
.
הערך מוגדר לכל משך החיים של קריאה חוזרת (callback) אם ממשק ה-API של תוסף א-כרוני הוביל לשגיאה. אם לא אירעה שגיאה, הערך LastError יהיה undefined
.
סוג
אובייקט
תכונות
-
הודעה
string
תיאור של השגיאה שהתרחשה.
שיטות
getBackgroundPage()
chrome.extension.getBackgroundPage()
מחזירה את האובייקט 'חלון' של JavaScript עבור דף הרקע שרץ בתוך התוסף הנוכחי. מחזירה null אם אין לתוסף דף רקע.
החזרות
-
חלון | לא מוגדר
getExtensionTabs()
chrome.extension.getExtensionTabs(
windowId?: number,
)
יש להשתמש ב-extension.getViews
{type: "tab"}
.
מחזירה מערך של האובייקטים של 'window' ב-JavaScript לכל אחת מהכרטיסיות שפועלות בתוך התוסף הנוכחי. אם צוין windowId
, הפונקציה מחזירה רק את האובייקטים של "window" של כרטיסיות שמצורפים לחלון שצוין.
פרמטרים
-
windowId
מספר אופציונלי
החזרות
-
חלון[]
מערך של אובייקטי חלון גלובליים
getURL()
chrome.extension.getURL(
path: string,
)
יש להשתמש ב-runtime.getURL
.
ממיר נתיב יחסי בתוך ספריית התקנה של תוסף לכתובת URL המוגדרת במלואה.
פרמטרים
-
נתיב
string
נתיב למשאב בתוך תוסף, ביחס לספריית ההתקנה שלו.
החזרות
-
string
כתובת ה-URL המוגדרת במלואה למשאב.
getViews()
chrome.extension.getViews(
fetchProperties?: object,
)
מחזירה מערך של אובייקטי 'window' של JavaScript עבור כל אחד מהדפים שפועלים בתוך התוסף הנוכחי.
פרמטרים
-
fetchProperties
אובייקט אופציונלי
-
tabId
מספר אופציונלי
Chrome בגרסה 54 ומעלהמחפשים תצוגה לפי מזהה כרטיסייה. אם לא מזינים שדה זה, הפונקציה מחזירה את כל התצוגות.
-
סוג
ViewType אופציונלי
סוג התצוגה שמקבלים. אם לא צוין, מוחזר כל הצפיות (כולל דפי רקע וכרטיסיות).
-
windowId
מספר אופציונלי
החלון שאליו רוצים להגביל את החיפוש. אם פרט זה לא צוין, הפונקציה מחזירה את כל הצפיות.
-
החזרות
-
חלון[]
מערך של אובייקטים גלובליים
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
מאחזר את מצב הגישה של התוסף לסכימה 'file://'. ההגדרה הזו זהה להגדרה 'מתן גישה לכתובות URL של קבצים' בשליטת המשתמש, שנגישה לכל תוסף דרך הדף chrome://extensions.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
הערך הוא True אם התוסף יכול לגשת לסכימה 'file://'. אחרת, צריך להזין את הערך false.
-
החזרות
-
Promise<boolean>
Chrome 99 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
isAllowedIncognitoAccess()
chrome.extension.isAllowedIncognitoAccess(
callback?: function,
)
מאחזר את מצב הגישה של התוסף למצב פרטי. ההגדרה הזו מקבילה להגדרה 'מותר במצב פרטי' לכל תוסף, שנמצאת בשליטת המשתמש, וניתן לגשת אליה דרך הדף chrome://extensions.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
הערך הוא True אם לתוסף יש גישה למצב פרטי. אחרת, false.
-
החזרות
-
Promise<boolean>
Chrome 99 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
sendRequest()
chrome.extension.sendRequest(
extensionId?: string,
request: any,
callback?: function,
)
יש להשתמש ב-runtime.sendMessage
.
שולח בקשה יחידה למאזינים אחרים בתוך התוסף. דומה ל-runtime.connect
, אך שולח בקשה אחת בלבד עם תשובה אופציונלית. האירוע extension.onRequest
מופעל בכל דף בתוסף.
פרמטרים
-
extensionId
מחרוזת אופציונלי
מזהה התוסף של התוסף שאליו רוצים להתחבר. אם פרט זה יושמט, ברירת המחדל היא התוסף שלך.
-
בקשה
הכול
-
קריאה חוזרת (callback)
פונקציה אופציונלי
Chrome 99 ומעלההפרמטר
callback
נראה כך:(response: any) => void
-
תשובה
הכול
אובייקט תגובת JSON שנשלח על ידי הגורם המטפל בבקשה. אם תתרחש שגיאה במהלך ההתחברות לתוסף, תתבצע קריאה חוזרת ללא ארגומנטים והסמל
runtime.lastError
יוגדר כהודעת השגיאה.
-
החזרות
-
מבטיח<any>
Chrome 99 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setUpdateUrlData()
chrome.extension.setUpdateUrlData(
data: string,
)
מגדירה את הערך של פרמטר ap CGI המשמש בכתובת ה-URL לעדכון התוסף. המערכת מתעלמת מהערך הזה בתוספים שמתארחים בגלריית התוספים של Chrome.
פרמטרים
-
נתונים
string
אירועים
onRequest
chrome.extension.onRequest.addListener(
callback: function,
)
יש להשתמש ב-runtime.onMessage
.
מופעל כשבקשה נשלחת מתהליך הארכה או מסקריפט תוכן.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
בקשה
הכול
-
sendResponse
פונקציה
הפרמטר
sendResponse
נראה כך:() => void
-
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
יש להשתמש ב-runtime.onMessageExternal
.
מופעל כשבקשה נשלחת מתוסף אחר.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
בקשה
הכול
-
sendResponse
פונקציה
הפרמטר
sendResponse
נראה כך:() => void
-