chrome.extension

refresh date: 2026-09-25 robots: noindex

תיאור

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

סוגים

ViewType

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

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

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

"tab"

"popup"

מאפיינים

inIncognitoContext

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

סוג

בוליאני

lastError

≤ MV2 הוצאה משימוש בגרסה Chrome 58

צריך להשתמש ב-runtime.lastError.

מוגדר למשך החיים של קריאה חוזרת (callback) אם API של תוסף אסינכרוני גרם לשגיאה. אם לא אירעה שגיאה, הערך של lastError יהיה undefined.

סוג

אובייקט

מאפיינים

• הודעה

  מחרוזת

  תיאור השגיאה שהתרחשה.

Methods

getBackgroundPage()

חזית בלבד

chrome.extension.getBackgroundPage(): Window | undefined

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

החזרות

• חלון | undefined

getExtensionTabs()

‫≤ MV2 חזית בלבד הוצאה משימוש

chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

צריך להשתמש ב-extension.getViews {type: "tab"}.

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

פרמטרים

• windowId

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

החזרות

• Window[]‎

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

getURL()

≤ MV2 הוצאה משימוש בגרסה Chrome 58

chrome.extension.getURL(
  path: string,
): string

צריך להשתמש ב-runtime.getURL.

המרת נתיב יחסי בתוך ספריית התקנה של תוסף לכתובת URL מוגדרת במלואה.

פרמטרים

• נתיב

  מחרוזת

  נתיב למשאב בתוך תוסף, שמוצג ביחס לספריית ההתקנה שלו.

החזרות

• מחרוזת

  כתובת ה-URL המלאה של המשאב.

getViews()

חזית בלבד

chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

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

פרמטרים

• fetchProperties

  object optional

  • tabId

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

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

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

  • סוג

    ViewType אופציונלי

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

  • windowId

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

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

החזרות

• Window[]‎

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

isAllowedFileSchemeAccess()

Promise

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

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

פרמטרים

• callback

  function optional

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

  (isAllowedAccess: boolean) => void

  • isAllowedAccess

    בוליאני

    הערך True אם התוסף יכול לגשת לסכימה 'file://‎', אחרת הערך False.

החזרות

• Promise<boolean>

  ‫Chrome מגרסה 99 ואילך

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

isAllowedIncognitoAccess()

Promise

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

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

פרמטרים

• callback

  function optional

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

  (isAllowedAccess: boolean) => void

  • isAllowedAccess

    בוליאני

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

החזרות

• Promise<boolean>

  ‫Chrome מגרסה 99 ואילך

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

sendRequest()

Promise &leq; MV2 הוצאה משימוש

chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

צריך להשתמש ב-runtime.sendMessage.

שולחת בקשה אחת למאזינים אחרים בתוך התוסף. דומה ל-runtime.connect, אבל שולח רק בקשה אחת עם תגובה אופציונלית. האירוע extension.onRequest מופעל בכל דף של התוסף.

פרמטרים

• extensionId

  מחרוזת אופציונלי

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

• בקשה

  כל

• callback

  function optional

  ‫Chrome מגרסה 99 ואילך

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

  (response: any) => void

  • תשובה

    כל

    אובייקט התגובה בפורמט JSON שנשלח על ידי ה-handler של הבקשה. אם תתרחש שגיאה במהלך ההתחברות לתוסף, ההבטחה תידחה.

החזרות

• Promise<any>

  ‫Chrome מגרסה 99 ואילך

  הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

setUpdateUrlData()

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

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

פרמטרים

• נתונים

  מחרוזת

אירועים

onRequest

‫&leq; MV2 הוצאה משימוש

chrome.extension.onRequest.addListener(
  callback: function,
)

צריך להשתמש ב-runtime.onMessage.

מופעל כשנשלחת בקשה מתהליך של תוסף או מסקריפט תוכן.

פרמטרים

• callback

  פונקציה

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

  (request: any, sender: runtime.MessageSender, sendResponse: function) => void

  • בקשה

    כל

  • שולח

    runtime.MessageSender

  • sendResponse

    פונקציה

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

    () => void

onRequestExternal

‫&leq; MV2 הוצאה משימוש

chrome.extension.onRequestExternal.addListener(
  callback: function,
)

צריך להשתמש ב-runtime.onMessageExternal.

מופעל כשנשלחת בקשה מתוסף אחר.

פרמטרים

• callback

  פונקציה

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

  (request: any, sender: runtime.MessageSender, sendResponse: function) => void

  • בקשה

    כל

  • שולח

    runtime.MessageSender

  • sendResponse

    פונקציה

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

    () => void