chrome.extension

תיאור

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

סוגים

ViewType

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

סוג תצוגת התוסף.

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

"tab"

"popup"

מאפיינים

inIncognitoContext

הערך הזה נכון לגבי סקריפטים של תוכן שפועלים בכרטיסיות פרטיות, ולגבי דפי תוספים שפועלים בתהליך פרטי. האפשרות השנייה רלוונטית רק לתוספים עם incognito_behavior מסוג 'split'.

סוג

בוליאני

Methods

getBackgroundPage()

חזית בלבד
chrome.extension.getBackgroundPage()

הפונקציה מחזירה את אובייקט ה-'window' של JavaScript לדף הרקע שפועל בתוך התוסף הנוכחי. הפונקציה מחזירה ערך null אם לסיום אין דף רקע.

החזרות

  • Window | undefined

getViews()

חזית בלבד
chrome.extension.getViews(
  fetchProperties?: object,
)

הפונקציה מחזירה מערך של אובייקטים מסוג 'window' ב-JavaScript לכל אחד מהדפים שפועלים בתוך התוסף הנוכחי.

פרמטרים

  • fetchProperties

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

    • tabId

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

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

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

    • סוג

      ViewType אופציונלי

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

    • windowId

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

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

החזרות

  • Window[]

    מערך של אובייקטים גלובליים

isAllowedFileSchemeAccess()

Promise
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

אחזור המצב של הגישה של התוסף לסכימה 'file://'. ההגדרה הזו תואמת להגדרה 'התרת גישה לכתובות אתרים של קבצים' לכל תוסף, שבה המשתמש יכול לשלוט דרך הדף chrome://extensions.

פרמטרים

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

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

      הערך יהיה TRUE אם הסיומת יכולה לגשת לסכימה 'file://', ו-FALSE במקרה אחר.

החזרות

  • Promise<boolean>

    גרסה 99 ואילך של Chrome

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

isAllowedIncognitoAccess()

Promise
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

אחזור המצב של הגישה של התוסף למצב פרטי. ההגדרה הזו תואמת להגדרה 'מותר במצב פרטי' שמוגדרת לכל תוסף בנפרד, והמשתמשים יכולים לשנות אותה בדף chrome://extensions.

פרמטרים

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

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

      הערך True אם לתוסף יש גישה למצב פרטי, ו-False אחרת.

החזרות

  • Promise<boolean>

    גרסה 99 ואילך של Chrome

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

הגדרת הערך של פרמטר ה-CGI של ap שמשמש בכתובת ה-URL לעדכון של התוסף. המערכת מתעלמת מהערך הזה לגבי תוספים שמתארחים בגלריה של התוספים ל-Chrome.

פרמטרים

  • נתונים

    מחרוזת

אירועים