browser.management

תיאור

‫chrome.management API מספק דרכים לנהל אפליקציות ותוספים מותקנים.

הרשאות

management

כדי להשתמש ב-Management API, צריך להצהיר על ההרשאה "ניהול" בקובץ המניפסט של התוסף. לדוגמה:

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

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

סוגים

ExtensionDisabledReason

Chrome 44 ואילך browser.* ‎ מ-Chrome 148

הסיבה לכך שהפריט מושבת.

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

"unknown"

"permissions_increase"

ExtensionInfo

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

מאפיינים

• appLaunchUrl

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

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

• availableLaunchTypes

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

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

• תיאור

  מחרוזת

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

• disabledReason

  ExtensionDisabledReason אופציונלי

  הסיבה לכך שהפריט מושבת.

• פעיל

  בוליאני

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

• homepageUrl

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

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

• hostPermissions

  string[]‎

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

• סמלים

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

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

• id [מזהה]

  מחרוזת

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

• installType

  ExtensionInstallType

  איך התוסף הותקן.

• isApp

  בוליאני

  הוצא משימוש

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

  ‫True אם מדובר באפליקציה.

• launchType

  LaunchType אופציונלי

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

• mayDisable

  בוליאני

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

• mayEnable

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

  ‫Chrome 62 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

• שם

  מחרוזת

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

• offlineEnabled

  בוליאני

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

• optionsUrl

  מחרוזת

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

• permissions

  string[]‎

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

• shortName

  מחרוזת

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

• סוג

  ExtensionType

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

• updateUrl

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

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

• גרסה

  מחרוזת

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

• versionName

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

  ‫Chrome 50 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

ExtensionInstallType

Chrome 44 ואילך browser.* ‎ מ-Chrome 148

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

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

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

Chrome 44 ואילך browser.* ‎ מ-Chrome 148

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

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

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

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

מאפיינים

• size

  number

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

• url

  מחרוזת

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

LaunchType

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

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

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

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

מאפיינים

• showConfirmDialog

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

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

Methods

createAppShortcut()

browser.management.createAppShortcut(
  id: string,
): Promise<void>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

generateAppForLink()

browser.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

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

פרמטרים

• url

  מחרוזת

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

• title

  מחרוזת

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

החזרות

• Promise<ExtensionInfo>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

get()

browser.management.get(
  id: string,
): Promise<ExtensionInfo>

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

פרמטרים

• id [מזהה]

  מחרוזת

  המזהה של פריט מ-management.ExtensionInfo.

החזרות

• Promise<ExtensionInfo>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

getAll()

browser.management.getAll(): Promise<ExtensionInfo[]>

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

החזרות

• Promise<ExtensionInfo[]>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

getPermissionWarningsById()

browser.management.getPermissionWarningsById(
  id: string,
): Promise<string[]>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

החזרות

• Promise<string[]>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

getPermissionWarningsByManifest()

browser.management.getPermissionWarningsByManifest(
  manifestStr: string,
): Promise<string[]>

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

פרמטרים

• manifestStr

  מחרוזת

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

החזרות

• Promise<string[]>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

getSelf()

browser.management.getSelf(): Promise<ExtensionInfo>

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

החזרות

• Promise<ExtensionInfo>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

installReplacementWebApp()

‫Chrome 77 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

browser.management.installReplacementWebApp(): Promise<void>

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

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

launchApp()

browser.management.launchApp(
  id: string,
): Promise<void>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

setEnabled()

browser.management.setEnabled(
  id: string,
  enabled: boolean,
): Promise<void>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

• פעיל

  בוליאני

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

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

setLaunchType()

browser.management.setLaunchType(
  id: string,
  launchType: LaunchType,
): Promise<void>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

• launchType

  LaunchType

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

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

uninstall()

browser.management.uninstall(
  id: string,
  options?: UninstallOptions,
): Promise<void>

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

פרמטרים

• id [מזהה]

  מחרוזת

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

• אפשרויות

  ‫UninstallOptions אופציונלי

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

uninstallSelf()

browser.management.uninstallSelf(
  options?: UninstallOptions,
): Promise<void>

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

פרמטרים

• אפשרויות

  ‫UninstallOptions אופציונלי

החזרות

• Promise<void>

  ‫Chrome 88 ואילך ‫browser.* ‎ מגרסה 148 של Chrome

אירועים

onDisabled

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

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

פרמטרים

• callback

  פונקציה

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

  (info: ExtensionInfo) => void

  • מידע

    ExtensionInfo

onEnabled

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

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

פרמטרים

• callback

  פונקציה

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

  (info: ExtensionInfo) => void

  • מידע

    ExtensionInfo

onInstalled

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

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

פרמטרים

• callback

  פונקציה

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

  (info: ExtensionInfo) => void

  • מידע

    ExtensionInfo

onUninstalled

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

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

פרמטרים

• callback

  פונקציה

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

  (id: string) => void

  • id [מזהה]

    מחרוזת