chrome.management

תיאור

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

הרשאות

management

מניפסט

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

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

management.getPermissionWarningsByManifest, management.uninstallSelf וגם management.getSelf לא נדרשים הרשאת ניהול.

סוגים

ExtensionDisabledReason

Chrome 44 ואילך

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

Enum

"לא ידוע"

"permissions_increase"

ExtensionInfo

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

מאפיינים

  • appLaunchUrl

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

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

  • availableLaunchTypes

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

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

  • תיאור

    מחרוזת

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

  • disabledReason

    ExtensionDisabledReason אופציונלית

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

  • פעיל

    בוליאני

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

  • homepageUrl

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

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

  • hostPermissions

    String[]

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

  • סמלים

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

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

  • id [מזהה]

    מחרוזת

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

  • installType

    ExtensionInstallType

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

  • isApp

    בוליאני

    הוצא משימוש

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

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

  • launchType

    LaunchType אופציונלי

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

  • mayDisable

    בוליאני

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

  • mayEnable

    ערך בוליאני אופציונלי

    Chrome 62+

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

  • שם

    מחרוזת

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

  • offlineEnabled

    בוליאני

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

  • optionsUrl

    מחרוזת

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

  • permissions

    String[]

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

  • שם קצר

    מחרוזת

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

  • סוג

    ExtensionType

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

  • updateUrl

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

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

  • גרסה

    מחרוזת

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

  • versionName

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

    Chrome 50+

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

ExtensionInstallType

Chrome 44 ואילך

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

Enum

"admin"

"פיתוח"

"רגיל"

"מטען צד"

"אחר"

ExtensionType

Chrome 44 ואילך

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

Enum

"תוסף"

"host_app"

"packaged_app"

"legacy_packaged_app"

"עיצוב"

"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

    ערך בוליאני אופציונלי

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

שיטות

createAppShortcut()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

    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&lt;ExtensionInfo&gt;

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

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

get()

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

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

פרמטרים

החזרות

  • Promise&lt;ExtensionInfo&gt;

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

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

getAll()

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

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

פרמטרים

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

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

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

    (result: ExtensionInfo[]) => void

החזרות

  • Promise&lt;ExtensionInfo[]&gt;

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

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

getPermissionWarningsById()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

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

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      String[]

החזרות

  • Promise&lt;string[]&gt;

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

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

getPermissionWarningsByManifest()

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

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

פרמטרים

  • manifestStr

    מחרוזת

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

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

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

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      String[]

החזרות

  • Promise&lt;string[]&gt;

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

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

getSelf()

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

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

פרמטרים

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

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

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

    (result: ExtensionInfo) => void

החזרות

  • Promise&lt;ExtensionInfo&gt;

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

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

installReplacementWebApp()

הבטחה Chrome מגרסה 77 ואילך 
chrome.management.installReplacementWebApp(
  callback?: function,
)

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

פרמטרים

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

launchApp()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

setEnabled()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • פעיל

    בוליאני

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

setLaunchType()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • launchType

    LaunchType

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

uninstall()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • אפשרויות

    UninstallOptions אופציונלי

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

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

uninstallSelf()

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

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

פרמטרים

  • אפשרויות

    UninstallOptions אופציונלי

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

    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 [מזהה]

      מחרוזת