chrome.extension

תאריך הרענון: 2026-09-25 robots: noindex

תיאור

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

סוגים

ViewType

‫Chrome 44 ואילך

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

ספירה

‫'tab'

‫"popup"

מאפיינים

inIncognitoContext

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

סוג

בוליאני

lastError

‫≤ MV2 הוצא משימוש מאז Chrome 58

במקומה יש להשתמש בruntime.lastError.

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

סוג

אובייקט

מאפיינים

  • הודעה

    מחרוזת

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

Methods

getBackgroundPage()

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

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

החזרות

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

getExtensionTabs()

‫≤ MV2 רק בחזית הוצא משימוש
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

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

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

פרמטרים

  • windowId

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

החזרות

  • Window[]

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

getURL()

‫≤ MV2 הוצא משימוש מאז Chrome 58
chrome.extension.getURL(
  path: string,
): string

במקומה יש להשתמש בruntime.getURL.

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

פרמטרים

  • נתיב

    מחרוזת

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

החזרות

  • מחרוזת

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

getViews()

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

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

פרמטרים

  • fetchProperties

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

    • tabId

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

      ‫Chrome 54 ואילך

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

    • סוג

      ‫ViewType אופציונלי

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

    • windowId

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

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

החזרות

  • Window[]

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

isAllowedFileSchemeAccess()

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

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

פרמטרים

  • callback

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך

    התמיכה ב-Promises קיימת רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.

isAllowedIncognitoAccess()

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

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

פרמטרים

  • callback

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

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

החזרות

  • Promise<boolean>

    ‫Chrome 99 ואילך

    התמיכה ב-Promises קיימת רק ב-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

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

    ‫Chrome 99 ואילך

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

    (response: any) => void

    • תשובה

      כל

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

החזרות

  • Promise<any>

    ‫Chrome 99 ואילך

    התמיכה ב-Promises קיימת רק ב-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

    • בקשה

      כל

    • sendResponse

      פונקציה

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

      () => void

onRequestExternal

‫&leq; MV2 הוצאה משימוש
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

במקומה יש להשתמש בruntime.onMessageExternal.

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

פרמטרים

  • callback

    פונקציה

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

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

    • בקשה

      כל

    • sendResponse

      פונקציה

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

      () => void