chrome.management

תיאור

באמצעות ה-API של chrome.management אפשר לנהל את רשימת התוספים או האפליקציות שמותקנות שפועלות. היא שימושית במיוחד לתוספים שמבטלים את הדף 'כרטיסייה חדשה' המובנה.

הרשאות

management

כדי להשתמש ב-Management API, עליכם להצהיר על ההרשאה 'ניהול' במניפסט התוספים. למשל:

{
  "name": "My extension",
  ...
  "permissions": [
    "management"
  ],
  ...
}

ל-management.getPermissionWarningsByManifest(), ל-management.uninstallSelf() ול-management.getSelf() לא נדרשת הרשאת ניהול.

סוגים

ExtensionDisabledReason

Chrome 44 ואילך

סיבה להשבתת הפריט.

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

ExtensionInfo

מידע על תוסף, אפליקציה או עיצוב שהותקנו.

תכונות

  • appLaunchUrl

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

    כתובת האתר להפעלה (זמינה רק לאפליקציות).

  • availableLaunchTypes

    LaunchType[] אופציונלי

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

  • תיאור

    מחרוזת

    התיאור של התוסף, האפליקציה או העיצוב.

  • disabledReason

    ExtensionDisabledReason אופציונלי

    סיבה להשבתת הפריט.

  • פעיל

    boolean

    האם היא מופעלת או מושבתת כרגע.

  • homepageUrl

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

    כתובת ה-URL של דף הבית של התוסף, האפליקציה או העיצוב.

  • hostPermissions

    מחרוזת[]

    מחזירה רשימה של הרשאות מבוססות-מארח.

  • סמלים

    IconInfo[] אופציונלי

    רשימה של מידע על הסמלים. חשוב לשים לב שהדבר משקף רק את מה שהוצהר במניפסט, והתמונה בפועל בכתובת ה-URL הזו עשויה להיות גדולה או קטנה יותר ממה שהוצהר, לכן כדאי להשתמש במאפייני רוחב וגובה מפורשים בתגי img ש מפנים לתמונות האלה. מידע נוסף זמין בתיעוד המניפסט על סמלים.

  • id

    מחרוזת

    המזהה הייחודי של התוסף.

  • installType

    ExtensionInstallType

    האופן שבו התוסף הותקן.

  • isApp

    boolean

    הוצא משימוש

    יש להשתמש ב-management.ExtensionInfo.type.

    True אם זו אפליקציה.

  • launchType

    LaunchType – אופציונלי

    סוג הפעלת האפליקציה (זמין רק לאפליקציות).

  • mayDisable

    boolean

    האם המשתמש יכול להשבית או להסיר את התוסף הזה.

  • mayEnable

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

    Chrome 62 ומעלה

    האם המשתמש יכול להפעיל את התוסף הזה. הערך הזה מוחזר רק עבור תוספים שלא הופעלו.

  • name

    מחרוזת

    השם של התוסף, האפליקציה או העיצוב.

  • offlineEnabled

    boolean

    האם התוסף, האפליקציה או העיצוב מצהירים שהם תומכים במצב אופליין.

  • optionsUrl

    מחרוזת

    כתובת ה-URL של דף האפשרויות של הפריט, אם יש לו דף כזה.

  • הרשאות

    מחרוזת[]

    מחזירה רשימה של הרשאות מבוססות API.

  • shortName

    מחרוזת

    גרסה קצרה של השם של התוסף, האפליקציה או העיצוב.

  • סוג

    ExtensionType

    הסוג של התוסף, האפליקציה או העיצוב.

  • updateUrl

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

    כתובת ה-URL לעדכון של התוסף, האפליקציה או העיצוב.

  • גרסה

    מחרוזת

    הגרסה של התוסף, האפליקציה או העיצוב.

  • versionName

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

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

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

ExtensionInstallType

Chrome 44 ואילך

האופן שבו התוסף הותקן. אחת מהאפשרויות: admin: התוסף הותקן בגלל מדיניות אדמין, development: התוסף נטען במצב פיתוח, normal: התוסף הותקן כרגיל דרך קובץ .crx, sideload: התוסף הותקן על ידי תוכנה אחרת במחשב, other: התוסף הותקן בדרך אחרת.

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

ExtensionType

Chrome 44 ואילך

הסוג של התוסף, האפליקציה או העיצוב.

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

"packaged_app"

"login_screen_extension"

IconInfo

מידע על סמל ששייך לתוסף, לאפליקציה או לעיצוב.

תכונות

  • גודל

    מספר

    מספר שמייצג את הרוחב והגובה של הסמל. הערכים האפשריים כוללים (בין היתר) 128, 48, 24 ו-16.

  • כתובת אתר

    מחרוזת

    כתובת ה-URL של תמונת הסמל הזו. כדי להציג גרסה של הסמל בגווני אפור (לדוגמה, כדי לציין שתוסף מושבת), יש לצרף את הסמל ?grayscale=true לכתובת ה-URL.

LaunchType

אלה כל סוגי ההשקות האפשריים של אפליקציות.

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

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

UninstallOptions

Chrome 88 ומעלה

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

תכונות

  • showConfirmDialog

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

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

שיטות

createAppShortcut()

הבטחה 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

הצגת אפשרויות ליצירת קיצורי דרך לאפליקציה. ב-Mac, ניתן ליצור רק קיצורי דרך לאפליקציות ארוזות.

פרמטרים

  • id

    מחרוזת

    המזהה הזה צריך להיות המזהה של פריט באפליקציה management.ExtensionInfo.

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

הבטחה 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

יצירת אפליקציה לכתובת URL. מחזירה את אפליקציית הסימניות שנוצרה.

פרמטרים

  • כתובת אתר

    מחרוזת

    כתובת ה-URL של דף האינטרנט. הסכמה של כתובת ה-URL יכולה להיות רק http או https.

  • title

    מחרוזת

    השם של האפליקציה שנוצרה.

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

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

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

    (result: ExtensionInfo)=>void

החזרות

  • Promise<ExtensionInfo>

    Chrome 88 ומעלה

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

get()

הבטחה 
chrome.management.get(
  id: string,
  callback?: function,
)

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

פרמטרים

החזרות

  • Promise<ExtensionInfo>

    Chrome 88 ומעלה

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

getAll()

הבטחה 
chrome.management.getAll(
  callback?: function,
)

מחזירה רשימת מידע על תוספים ואפליקציות מותקנים.

פרמטרים

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

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

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

    (result: ExtensionInfo[])=>void

החזרות

  • Promise<ExtensionInfo[]>

    Chrome 88 ומעלה

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

getPermissionWarningsById()

הבטחה 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

מחזירה רשימה של אזהרות הרשאה עבור מזהה התוסף הנתון.

פרמטרים

  • id

    מחרוזת

    המזהה של תוסף שכבר הותקן.

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

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

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

    (permissionWarnings: string[])=>void

    • permissionWarnings

      מחרוזת[]

החזרות

  • הבטחה<string[]>

    Chrome 88 ומעלה

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

getPermissionWarningsByManifest()

הבטחה 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

מחזירה רשימה של אזהרות הרשאה עבור מחרוזת המניפסט הנתונה. הערה: ניתן להשתמש בפונקציה הזו בלי לבקש את ההרשאה 'ניהול' במניפסט.

פרמטרים

  • manifestStr

    מחרוזת

    מחרוזת JSON של מניפסט תוסף.

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

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

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

    (permissionWarnings: string[])=>void

    • permissionWarnings

      מחרוזת[]

החזרות

  • הבטחה<string[]>

    Chrome 88 ומעלה

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

getSelf()

הבטחה 
chrome.management.getSelf(
  callback?: function,
)

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

פרמטרים

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

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

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

    (result: ExtensionInfo)=>void

החזרות

  • Promise<ExtensionInfo>

    Chrome 88 ומעלה

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

installReplacementWebApp()

Promise Chrome 77 ואילך 
chrome.management.installReplacementWebApp(
  callback?: function,
)

מפעיל את new_web_app שצוין במניפסט. תוצג למשתמש בקשה להתקין את האפליקציה, אם היא עדיין לא הותקנה.

פרמטרים

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

launchApp()

הבטחה 
chrome.management.launchApp(
  id: string,
  callback?: function,
)

הפעלת אפליקציה.

פרמטרים

  • id

    מחרוזת

    מזהה התוסף של האפליקציה.

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

setEnabled()

הבטחה 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

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

פרמטרים

  • id

    מחרוזת

    זה צריך להיות המזהה מפריט של management.ExtensionInfo.

  • פעיל

    boolean

    האם יש להפעיל או להשבית את הפריט הזה.

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

setLaunchType()

הבטחה 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

הגדרת סוג ההשקה של אפליקציה.

פרמטרים

  • id

    מחרוזת

    המזהה הזה צריך להיות המזהה של פריט באפליקציה management.ExtensionInfo.

  • launchType

    LaunchType

    סוג היעד של השקת היעד. צריך תמיד לוודא שסוג ההשקה הזה נמצא ב-ExtensionInfo.availableLaunchTypes, כי סוגי ההשקה הזמינים משתנים בהתאם לפלטפורמות ולהגדרות השונות.

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

uninstall()

הבטחה 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

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

פרמטרים

  • id

    מחרוזת

    זה צריך להיות המזהה מפריט של management.ExtensionInfo.

  • אפשרויות

    UninstallOptions אופציונלי

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

uninstallSelf()

הבטחה 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

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

פרמטרים

  • אפשרויות

    UninstallOptions אופציונלי

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

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

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

    ()=>void

החזרות

  • Promise<void>

    Chrome 88 ומעלה

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

אירועים

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

מופעל כשאפליקציה או תוסף מושבתים.

פרמטרים

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

    פונקציה

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

    (info: ExtensionInfo)=>void

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

מופעל כשאפליקציה או תוסף מופעלים.

פרמטרים

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

    פונקציה

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

    (info: ExtensionInfo)=>void

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

מופעל כשאפליקציה או תוסף מותקנים.

פרמטרים

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

    פונקציה

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

    (info: ExtensionInfo)=>void

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (id: string)=>void

    • id

      מחרוזת