chrome.management

תיאור

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

הרשאות

management

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

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

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

סוגים

ExtensionDisabledReason

‫Chrome 44 ואילך

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

Enum

‫'unknown'

‫"permissions_increase"

ExtensionInfo

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

מאפיינים

  • appLaunchUrl

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

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

  • availableLaunchTypes

    LaunchType[] optional

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

  • תיאור

    מחרוזת

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

  • disabledReason

    ‫ExtensionDisabledReason אופציונלי

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

  • פעיל

    בוליאני

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

  • homepageUrl

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

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

  • hostPermissions

    string[]

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

  • סמלים

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

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

  • id [מזהה]

    מחרוזת

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

  • installType

    ExtensionInstallType

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

  • isApp

    בוליאני

    הוצא משימוש

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

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

  • launchType

    ‫LaunchType אופציונלי

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

  • mayDisable

    בוליאני

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

  • mayEnable

    ‫boolean אופציונלי

    ‫Chrome 62 ואילך

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

  • שם

    מחרוזת

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

  • offlineEnabled

    בוליאני

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

  • optionsUrl

    מחרוזת

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

  • permissions

    string[]

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

  • shortName

    מחרוזת

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

  • סוג

    ExtensionType

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

  • updateUrl

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

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

  • גרסה

    מחרוזת

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

  • versionName

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

    ‫Chrome 50 ואילך

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

ExtensionInstallType

‫Chrome 44 ואילך

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

Enum

‎"admin"

‎"development"

"normal"

"sideload"

"other"

ExtensionType

‫Chrome 44 ואילך

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

Enum

‎"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

‫"theme"

"login_screen_extension"

IconInfo

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

מאפיינים

  • size

    number

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

  • כתובת אתר

    מחרוזת

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

LaunchType

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

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

‎"OPEN_FULL_SCREEN"

UninstallOptions

‫Chrome 88 ואילך

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

מאפיינים

  • showConfirmDialog

    ‫boolean אופציונלי

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

Methods

createAppShortcut()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך 
chrome.management.generateAppForLink(
  url: string,
  title: string,
): Promise<ExtensionInfo>

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

פרמטרים

  • כתובת אתר

    מחרוזת

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

  • title

    מחרוזת

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

החזרות

get()

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

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

פרמטרים

החזרות

getAll()

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

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

החזרות

getPermissionWarningsById()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

החזרות

  • Promise<string[]>

    ‫Chrome 88 ואילך

getPermissionWarningsByManifest()

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

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

פרמטרים

  • manifestStr

    מחרוזת

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

החזרות

  • Promise<string[]>

    ‫Chrome 88 ואילך

getSelf()

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

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

החזרות

installReplacementWebApp()

‫Chrome 77 ואילך 
chrome.management.installReplacementWebApp(): Promise<void>

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

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

launchApp()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

setEnabled()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • פעיל

    בוליאני

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

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

setLaunchType()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • launchType

    LaunchType

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

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

uninstall()

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

uninstallSelf()

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

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

פרמטרים

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

אירועים

onDisabled

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

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

פרמטרים

onEnabled

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

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

פרמטרים

onInstalled

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

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

פרמטרים

onUninstalled

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

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

פרמטרים

  • callback

    פונקציה

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

    (id: string) => void

    • id [מזהה]

      מחרוזת