browser.extension

תיאור

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

סוגים

ViewType

Chrome 44 ואילך browser.* ‎ מ-Chrome 148

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

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

"tab"

"popup"

מאפיינים

inIncognitoContext

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

סוג

בוליאני

Methods

getBackgroundPage()

חזית בלבד 
browser.extension.getBackgroundPage(): Window | undefined

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

החזרות

  • חלון | undefined

getViews()

חזית בלבד 
browser.extension.getViews(
  fetchProperties?: object,
): Window[]

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

פרמטרים

  • fetchProperties

    object optional

    • tabId

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

      ‫Chrome 54 ואילך browser.* ‎ מגרסה 148 של Chrome

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

    • סוג

      ViewType אופציונלי

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

    • windowId

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

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

החזרות

  • Window[]‎

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

isAllowedFileSchemeAccess()

browser.extension.isAllowedFileSchemeAccess(): Promise<boolean>

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

isAllowedIncognitoAccess()

browser.extension.isAllowedIncognitoAccess(): Promise<boolean>

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

setUpdateUrlData()

browser.extension.setUpdateUrlData(
  data: string,
): void

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

פרמטרים

  • נתונים

    מחרוזת