chrome.management

شرح

chrome.management API راه‌هایی برای مدیریت فهرست افزونه‌ها/برنامه‌هایی که نصب و اجرا شده‌اند ارائه می‌کند. مخصوصاً برای برنامه‌های افزودنی که صفحه تب جدید داخلی را لغو می‌کنند مفید است.

مجوزها

management

برای استفاده از API مدیریت، باید مجوز «مدیریت» را در مانیفست افزونه اعلام کنید. مثلا:

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

management.getPermissionWarningsByManifest() ، management.uninstallSelf() و management.getSelf() به مجوز مدیریت نیاز ندارند.

انواع

ExtensionDisabledReason

Chrome 44+

دلیلی که مورد غیرفعال است.

Enum

"ناشناخته"

"permissions_increase"

ExtensionInfo

اطلاعاتی درباره برنامه افزودنی، برنامه یا طرح زمینه نصب شده.

خواص

  • appLaunchUrl

    رشته اختیاری

    آدرس راه‌اندازی (فقط برای برنامه‌ها موجود است).

  • در دسترس LaunchTypes

    LaunchType [] اختیاری است

    انواع راه اندازی موجود در حال حاضر (فقط برای برنامه ها موجود است).

  • شرح

    رشته

    شرح این برنامه افزودنی، برنامه یا طرح زمینه.

  • disabledReason

    ExtensionDisabledReason اختیاری است

    دلیلی که مورد غیرفعال است.

  • فعال شد

    بولی

    خواه در حال حاضر فعال یا غیرفعال باشد.

  • آدرس صفحه اصلی

    رشته اختیاری

    نشانی وب صفحه اصلی این برنامه افزودنی، برنامه یا طرح زمینه.

  • مجوزهای میزبان

    رشته[]

    فهرستی از مجوزهای مبتنی بر میزبان را برمی‌گرداند.

  • نمادها

    IconInfo [] اختیاری است

    لیستی از اطلاعات نمادها توجه داشته باشید که این فقط همان چیزی است که در مانیفست اعلام شده است، و تصویر واقعی در آن نشانی اینترنتی ممکن است بزرگتر یا کوچکتر از آنچه اعلام شده باشد، بنابراین می توانید از ویژگی های عرض و ارتفاع صریح در تگ های img استفاده کنید که به این تصاویر ارجاع می دهند. برای جزئیات بیشتر به مستندات مانیفست روی نمادها مراجعه کنید.

  • شناسه

    رشته

    شناسه منحصر به فرد برنامه افزودنی.

  • نحوه نصب افزونه

  • isApp

    بولی

    منسوخ

    لطفا از management.ExtensionInfo.type استفاده کنید.

    درست است اگر این یک برنامه است.

  • نوع راه اندازی

    LaunchType اختیاری است

    نوع راه‌اندازی برنامه (فقط برای برنامه‌ها موجود است).

  • ممکن است غیرفعال شود

    بولی

    اینکه کاربر می‌تواند این برنامه افزودنی را غیرفعال یا حذف نصب کند.

  • ممکن است فعال شود

    بولی اختیاری

    Chrome 62+

    آیا این برنامه افزودنی می تواند توسط کاربر فعال شود یا خیر. این فقط برای برنامه های افزودنی که فعال نیستند بازگردانده می شود.

  • نام

    رشته

    نام این برنامه افزودنی، برنامه یا طرح زمینه.

  • آفلاین فعال شد

    بولی

    چه برنامه افزودنی، برنامه یا طرح زمینه اعلام کند که به صورت آفلاین پشتیبانی می کند.

  • OptionsUrl

    رشته

    نشانی وب صفحه گزینه‌های مورد، در صورتی که دارای یکی باشد.

  • مجوزها

    رشته[]

    فهرستی از مجوزهای مبتنی بر API را برمی‌گرداند.

  • نام کوتاه

    رشته

    نسخه کوتاهی از نام این برنامه افزودنی، برنامه یا طرح زمینه.

  • نوع این برنامه افزودنی، برنامه یا طرح زمینه.

  • updateUrl

    رشته اختیاری

    نشانی وب به‌روزرسانی این برنامه افزودنی، برنامه یا طرح زمینه.

  • نسخه

    رشته

    نسخه این برنامه افزودنی، برنامه یا طرح زمینه.

  • نام نسخه

    رشته اختیاری

    Chrome 50+

    نام نسخه این برنامه افزودنی، برنامه یا طرح زمینه در صورتی که مانیفست یکی را مشخص کرده باشد.

ExtensionInstallType

Chrome 44+

نحوه نصب افزونه یکی از admin : برنامه افزودنی به دلیل یک خط‌مشی اداری نصب شد، development : برنامه افزودنی بدون بسته‌بندی در حالت توسعه‌دهنده بارگیری شد، normal : برنامه افزودنی به طور معمول از طریق یک فایل crx. نصب شد، sideload : پسوند توسط نرم‌افزارهای دیگر روی دستگاه نصب شد , other : افزونه با روش های دیگری نصب شد.

Enum

"مدیر"

"توسعه"

"طبیعی"

"بار جانبی"

"دیگر"

ExtensionType

Chrome 44+

نوع این برنامه افزودنی، برنامه یا طرح زمینه.

Enum

"افزونه"

"hosted_app"

"packaged_app"

"legacy_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"

"OPEN_FULL_SCREEN"

UninstallOptions

Chrome 88+

گزینه هایی برای نحوه مدیریت حذف نصب برنامه افزودنی.

خواص

  • showConfirmDialog

    بولی اختیاری

    اینکه آیا یک گفتگوی تایید-حذف نصب باید از کاربر درخواست کند یا خیر. پیش‌فرض‌ها به false برای حذف نصب‌شده توسط خود. اگر یک برنامه افزودنی برنامه افزودنی دیگر را حذف نصب کند، این پارامتر نادیده گرفته می شود و گفتگو همیشه نشان داده می شود.

مواد و روش ها

createAppShortcut()

وعده
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
)

نمایش گزینه هایی برای ایجاد میانبر برای یک برنامه. در مک، فقط میانبرهای بسته بندی شده برنامه را می توان ایجاد کرد.

مولفه های

  • شناسه

    رشته

    این باید شناسه یک مورد برنامه management.ExtensionInfo باشد.ExtensionInfo.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

وعده
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
)

یک برنامه برای URL ایجاد کنید. برنامه نشانک ایجاد شده را برمی گرداند.

مولفه های

  • آدرس اینترنتی

    رشته

    آدرس یک صفحه وب. طرح URL فقط می تواند "http" یا "https" باشد.

  • عنوان

    رشته

    عنوان برنامه تولید شده

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: ExtensionInfo)=>void

برمی گرداند

  • Promise< ExtensionInfo >

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

get()

وعده
chrome.management.get(
  id: string,
  callback?: function,
)

اطلاعات مربوط به برنامه افزودنی، برنامه یا طرح زمینه نصب شده دارای شناسه داده شده را برمی گرداند.

مولفه های

برمی گرداند

  • Promise< ExtensionInfo >

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getAll()

وعده
chrome.management.getAll(
  callback?: function,
)

فهرستی از اطلاعات مربوط به برنامه های افزودنی و برنامه های نصب شده را برمی گرداند.

مولفه های

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: ExtensionInfo[])=>void

برمی گرداند

  • Promise< ExtensionInfo []>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getPermissionWarningsById()

وعده
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
)

فهرستی از هشدارهای مجوز برای شناسه برنامه افزودنی داده شده را برمی گرداند.

مولفه های

  • شناسه

    رشته

    شناسه یک افزونه از قبل نصب شده است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (permissionWarnings: string[])=>void

    • مجوز هشدارها

      رشته[]

برمی گرداند

  • قول<string[]>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getPermissionWarningsByManifest()

وعده
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
)

فهرستی از هشدارهای مجوز برای رشته مانیفست پسوند داده شده را برمی گرداند. توجه: این تابع را می توان بدون درخواست مجوز "مدیریت" در مانیفست استفاده کرد.

مولفه های

  • manifestStr

    رشته

    رشته JSON مانیفست پسوند.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (permissionWarnings: string[])=>void

    • مجوز هشدارها

      رشته[]

برمی گرداند

  • قول<string[]>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

getSelf()

وعده
chrome.management.getSelf(
  callback?: function,
)

اطلاعات مربوط به برنامه افزودنی، برنامه یا طرح زمینه تماس را برمی‌گرداند. توجه: این تابع را می توان بدون درخواست مجوز "مدیریت" در مانیفست استفاده کرد.

مولفه های

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: ExtensionInfo)=>void

برمی گرداند

  • Promise< ExtensionInfo >

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

installReplacementWebApp()

Promise Chrome 77+
chrome.management.installReplacementWebApp(
  callback?: function,
)

جایگزین_web_app مشخص شده در مانیفست را راه اندازی می کند. از کاربر می خواهد در صورتی که قبلاً نصب نشده است نصب کند.

مولفه های

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

launchApp()

وعده
chrome.management.launchApp(
  id: string,
  callback?: function,
)

برنامه ای را راه اندازی می کند.

مولفه های

  • شناسه

    رشته

    شناسه پسوند برنامه

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setEnabled()

وعده
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
)

یک برنامه یا برنامه افزودنی را فعال یا غیرفعال می کند. در بیشتر موارد، این تابع باید در زمینه یک اشاره کاربر فراخوانی شود (مثلاً یک کنترل کننده کلیک برای یک دکمه)، و ممکن است به کاربر یک رابط کاربری تأیید بومی را به عنوان راهی برای جلوگیری از سوء استفاده ارائه دهد.

مولفه های

  • شناسه

    رشته

    این باید شناسه یک مورد management.ExtensionInfo باشد.ExtensionInfo.

  • فعال شد

    بولی

    اینکه آیا این مورد باید فعال یا غیرفعال شود.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

setLaunchType()

وعده
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
)

نوع راه اندازی یک برنامه را تنظیم کنید.

مولفه های

  • شناسه

    رشته

    این باید شناسه یک مورد برنامه management.ExtensionInfo باشد.ExtensionInfo.

  • نوع راه اندازی

    LaunchType

    نوع پرتاب هدف همیشه بررسی کنید و مطمئن شوید که این نوع راه‌اندازی در ExtensionInfo.availableLaunchTypes است، زیرا انواع راه‌اندازی موجود در پلتفرم‌ها و پیکربندی‌های مختلف متفاوت است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

uninstall()

وعده
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
)

برنامه یا برنامه افزودنی نصب شده فعلی را حذف نصب می کند. توجه: وقتی کاربر مجاز به حذف برنامه افزودنی/برنامه مشخص شده نیست، این عملکرد در محیط های مدیریت شده کار نمی کند. اگر حذف ناموفق باشد (مثلاً کاربر گفتگو را لغو کند) وعده رد می شود یا تماس برگشتی با تنظیم runtime.lastError فراخوانی می شود.

مولفه های

  • شناسه

    رشته

    این باید شناسه یک مورد management.ExtensionInfo باشد.ExtensionInfo.

  • گزینه ها

    UninstallOptions اختیاری است

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

uninstallSelf()

وعده
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
)

برنامه افزودنی تماس را حذف نصب می کند. توجه: این تابع را می توان بدون درخواست مجوز "مدیریت" در مانیفست استفاده کرد. وقتی کاربر مجاز به حذف برنامه افزودنی/برنامه مشخص شده نیست، این عملکرد در محیط های مدیریت شده کار نمی کند.

مولفه های

  • گزینه ها

    UninstallOptions اختیاری است

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    ()=>void

برمی گرداند

  • قول<باطل>

    Chrome 88+

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

مناسبت ها

onDisabled

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

زمانی فعال می شود که یک برنامه یا برنامه افزودنی غیرفعال شده باشد.

مولفه های

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (info: ExtensionInfo)=>void

onEnabled

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

زمانی فعال می شود که یک برنامه یا برنامه افزودنی فعال شده باشد.

مولفه های

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (info: ExtensionInfo)=>void

onInstalled

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

هنگامی که یک برنامه یا برنامه افزودنی نصب شده است فعال می شود.

مولفه های

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (info: ExtensionInfo)=>void

onUninstalled

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

وقتی برنامه یا برنامه افزودنی حذف نصب شده باشد فعال می شود.

مولفه های

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (id: string)=>void

    • شناسه

      رشته