chrome.extension

توضیحات

API chrome.extension دارای ابزارهایی است که می‌تواند توسط هر صفحه افزونه‌ای مورد استفاده قرار گیرد. این API شامل پشتیبانی از تبادل پیام بین یک افزونه و اسکریپت‌های محتوای آن یا بین افزونه‌ها است، همانطور که به تفصیل در بخش «انتقال پیام» توضیح داده شده است.

انواع

ViewType

کروم ۴۴+

نوع نمای افزونه.

شمارشی

"تب"

"پاپ‌آپ"

خواص

inIncognitoContext

True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.

نوع

بولی

lastError

≤ MV2 از زمان کروم ۵۸ منسوخ شده است

لطفاً از runtime.lastError استفاده کنید.

Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be undefined .

نوع

شیء

خواص

• پیام

  رشته

  شرح خطای رخ داده.

روش‌ها

getBackgroundPage()

فقط پیش‌زمینه

chrome.extension.getBackgroundPage(): Window | undefined

Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.

بازگشت‌ها

• پنجره | تعریف نشده

getExtensionTabs()

≤ فقط پیش‌زمینه MV2 منسوخ شده

chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

لطفاً از extension.getViews {type: "tab"} استفاده کنید.

آرایه‌ای از اشیاء «پنجره» جاوا اسکریپت را برای هر یک از تب‌هایی که درون افزونه فعلی اجرا می‌شوند، برمی‌گرداند. اگر windowId مشخص شده باشد، فقط اشیاء «پنجره» تب‌هایی که به پنجره مشخص شده متصل هستند را برمی‌گرداند.

پارامترها

• شناسه پنجره

  شماره اختیاری

بازگشت‌ها

• پنجره[]

  آرایه‌ای از اشیاء پنجره سراسری

getURL()

≤ MV2 از زمان کروم ۵۸ منسوخ شده است

chrome.extension.getURL(
  path: string,
): string

لطفا از runtime.getURL استفاده کنید.

Converts a relative path within an extension install directory to a fully-qualified URL.

پارامترها

• مسیر

  رشته

  A path to a resource within an extension expressed relative to its install directory.

بازگشت‌ها

• رشته

  آدرس اینترنتی (URL) کاملاً واجد شرایط برای منبع.

getViews()

فقط پیش‌زمینه

chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.

پارامترها

• واکشی ویژگی‌ها

  شیء اختیاری

  • شناسه برگه

    شماره اختیاری

    کروم ۵۴+

    Find a view according to a tab id. If this field is omitted, returns all views.

  • نوع

    نوع نمایش اختیاری

    The type of view to get. If omitted, returns all views (including background pages and tabs).

  • شناسه پنجره

    شماره اختیاری

    The window to restrict the search to. If omitted, returns all views.

بازگشت‌ها

• پنجره[]

  آرایه‌ای از اشیاء سراسری

isAllowedFileSchemeAccess()

وعده

chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

وضعیت دسترسی افزونه به طرح 'file://' را بازیابی می‌کند. این مربوط به تنظیم 'Allow access to File URLs' برای هر افزونه است که توسط کاربر کنترل می‌شود و از طریق صفحه chrome://extensions قابل دسترسی است.

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به شکل زیر است:

  (isAllowedAccess: boolean) => void

  • دسترسی مجاز است

    بولی

    True if the extension can access the 'file://' scheme, false otherwise.

بازگشت‌ها

• قول <boolean>

  کروم ۹۹+

  Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

isAllowedIncognitoAccess()

وعده

chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

وضعیت دسترسی افزونه به حالت ناشناس را بازیابی می‌کند. این مربوط به تنظیم «مجاز در حالت ناشناس» برای هر افزونه است که توسط کاربر کنترل می‌شود و از طریق صفحه chrome://extensions قابل دسترسی است.

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به شکل زیر است:

  (isAllowedAccess: boolean) => void

  • دسترسی مجاز است

    بولی

    True if the extension has access to Incognito mode, false otherwise.

بازگشت‌ها

• قول <boolean>

  کروم ۹۹+

  Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

sendRequest()

Promise ≤ MV2 منسوخ شده

chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

لطفا از runtime.sendMessage استفاده کنید.

یک درخواست واحد را به سایر شنوندگان درون افزونه ارسال می‌کند. مشابه runtime.connect است، اما فقط یک درخواست واحد با یک پاسخ اختیاری ارسال می‌کند. رویداد extension.onRequest در هر صفحه از افزونه اجرا می‌شود.

پارامترها

• شناسه افزونه

  رشته اختیاری

  The extension ID of the extension you want to connect to. If omitted, default is your own extension.

• درخواست

  هر

• تماس برگشتی

  تابع اختیاری

  کروم ۹۹+

  پارامتر callback به شکل زیر است:

  (response: any) => void

  • پاسخ

    هر

    The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the promise will be rejected.

بازگشت‌ها

• قول بده<any>

  کروم ۹۹+

  Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the Chrome Extension Gallery.

پارامترها

• داده‌ها

  رشته

رویدادها

onRequest

≤ MV2 منسوخ شده

chrome.extension.onRequest.addListener(
  callback: function,
)

لطفا از runtime.onMessage استفاده کنید.

Fired when a request is sent from either an extension process or a content script.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (request: any, sender: runtime.MessageSender, sendResponse: function) => void

  • درخواست

    هر

  • فرستنده

    فرستنده پیام در زمان اجرا

  • ارسال پاسخ

    تابع

    پارامتر sendResponse به شکل زیر است:

    () => void

onRequestExternal

≤ MV2 منسوخ شده

chrome.extension.onRequestExternal.addListener(
  callback: function,
)

لطفاً از runtime.onMessageExternal استفاده کنید.

Fired when a request is sent from another extension.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (request: any, sender: runtime.MessageSender, sendResponse: function) => void

  • درخواست

    هر

  • فرستنده

    فرستنده پیام در زمان اجرا

  • ارسال پاسخ

    تابع

    پارامتر sendResponse به شکل زیر است:

    () => void