chrome.extension

תיאור

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

סוגים

ViewType

Chrome 44 ואילך

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

Enum

"tab"

"חלון קופץ"

מאפיינים

inIncognitoContext

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

סוג

בוליאני

lastError

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

יש להשתמש ב-runtime.lastError.

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

סוג

אובייקט

מאפיינים

  • הודעה

    מחרוזת

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

שיטות

getBackgroundPage()

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

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

החזרות

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

getExtensionTabs()

≤ MV2 חזית בלבד הוצא משימוש
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

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

פרמטרים

  • windowId

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

החזרות

  • חלון[]

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

getURL()

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

יש להשתמש ב-runtime.getURL.

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

פרמטרים

  • נתיב

    מחרוזת

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

החזרות

  • מחרוזת

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

getViews()

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

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

פרמטרים

  • fetchProperties

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

    • tabId

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

      Chrome 54+

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

    • סוג

      ViewType אופציונלי

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

    • windowId

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

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

החזרות

  • חלון[]

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

isAllowedFileSchemeAccess()

הבטחה 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

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

פרמטרים

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

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

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

החזרות

  • Promise<boolean>

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

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

isAllowedIncognitoAccess()

הבטחה 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

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

פרמטרים

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

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

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      בוליאני

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

החזרות

  • Promise<boolean>

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

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

sendRequest()

הבטחה ≤ MV2 הוצא משימוש
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

יש להשתמש ב-runtime.sendMessage.

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

פרמטרים

  • extensionId

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

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

  • בקשה

    כל

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

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

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

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

    (response: any) => void

    • תשובה

      כל

      האובייקט של תגובת JSON שנשלח על ידי ה-handler של הבקשה. אם תתרחש שגיאה במהלך ההתחברות לתוסף, תתבצע קריאה חוזרת (callback) ללא ארגומנטים, והערך runtime.lastError יוגדר בהודעת השגיאה.

החזרות

  • הבטחה<כלשהו>

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

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

פרמטרים

  • נתונים

    מחרוזת

אירועים

onRequest

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

יש להשתמש ב-runtime.onMessage.

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

פרמטרים

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

    פונקציה

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

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

    • בקשה

      כל

    • sendResponse

      פונקציה

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

      () => void

onRequestExternal

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

יש להשתמש ב-runtime.onMessageExternal.

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

פרמטרים

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

    פונקציה

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

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

    • בקשה

      כל

    • sendResponse

      פונקציה

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

      () => void