chrome.extension

תיאור

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

סוגים

ViewType

‫Chrome 44 ואילך

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

Enum

‫"tab"

‫"popup"

מאפיינים

inIncognitoContext

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

סוג

בוליאני

Methods

getBackgroundPage()

רק בחזית 
chrome.extension.getBackgroundPage(): Window | undefined

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

החזרות

  • חלון | לא מוגדר

getViews()

רק בחזית 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

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

פרמטרים

  • fetchProperties

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

    • tabId

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

      ‫Chrome 54 ואילך

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

    • סוג

      ‫ViewType אופציונלי

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

    • windowId

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

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

החזרות

  • Window[]

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

isAllowedFileSchemeAccess()

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

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך

isAllowedIncognitoAccess()

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

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך

setUpdateUrlData()

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

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

פרמטרים

  • נתונים

    מחרוזת

אירועים