chrome.extension

توضیحات

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

انواع

ViewType

Chrome 44+

نوع نمای پسوند.

Enum

"تب"

"پاپ آپ"

خواص

inIncognitoContext

برای اسکریپت‌های محتوایی که در برگه‌های ناشناس اجرا می‌شوند، و برای صفحات افزونه‌ای که در یک فرآیند ناشناس اجرا می‌شوند، درست است. مورد دوم فقط برای برنامه های افزودنی با رفتار ناشناس "تقسیم" اعمال می شود.

تایپ کنید

بولی

lastError

≤ MV2 از Chrome 58 منسوخ شده است

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

اگر Api برنامه افزودنی ناهمزمان منجر به خطا شده است، طول عمر تماس را تنظیم کنید. اگر خطایی رخ نداده است lastError undefined خواهد بود.

تایپ کنید

شی

خواص

  • پیام

    رشته

    شرح خطایی که رخ داده است.

روش ها

getBackgroundPage()

فقط پیش زمینه
chrome.extension.getBackgroundPage()

شیء «پنجره» جاوا اسکریپت را برای صفحه پس‌زمینه در حال اجرا در پسوند فعلی برمی‌گرداند. اگر برنامه افزودنی صفحه پس‌زمینه نداشته باشد، پوچ برمی‌گرداند.

برمی گرداند

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

getExtensionTabs()

≤ پیش زمینه MV2 فقط منسوخ شده است
 
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

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

پارامترها

  • شناسه پنجره

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

برمی گرداند

  • پنجره[]

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

getURL()

≤ MV2 از Chrome 58 منسوخ شده است
 
chrome.extension.getURL(
  path: string,
)

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

یک مسیر نسبی را در دایرکتوری نصب برنامه افزودنی به یک URL کاملاً واجد شرایط تبدیل می کند.

پارامترها

  • مسیر

    رشته

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

برمی گرداند

  • رشته

    URL کاملاً واجد شرایط منبع.

getViews()

فقط پیش زمینه
chrome.extension.getViews(
  fetchProperties?: object,
)

آرایه ای از اشیاء "پنجره" جاوا اسکریپت را برای هر یک از صفحات در حال اجرا در داخل برنامه افزودنی فعلی برمی گرداند.

پارامترها

  • fetchProperties

    شی اختیاری

    • tabId

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

      Chrome 54+

      با توجه به شناسه برگه یک نما پیدا کنید. اگر این فیلد حذف شود، همه نماها را برمی گرداند.

    • نوع

      ViewType اختیاری است

      نوع دید برای دریافت. اگر حذف شود، همه نماها (از جمله صفحات پس‌زمینه و برگه‌ها) را برمی‌گرداند.

    • شناسه پنجره

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

      پنجره ای برای محدود کردن جستجو. اگر حذف شود، همه نماها را برمی گرداند.

برمی گرداند

  • پنجره[]

    آرایه ای از اشیاء جهانی

isAllowedFileSchemeAccess()

قول بده
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

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

پارامترها

  • پاسخ به تماس

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

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

    (isAllowedAccess: boolean) => void

    • استAllowedAccess

      بولی

      اگر افزونه بتواند به طرح «file://» دسترسی داشته باشد صحیح است، در غیر این صورت نادرست است.

برمی گرداند

  • وعده<boolean>

    Chrome 99+

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

isAllowedIncognitoAccess()

قول بده
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

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

پارامترها

  • پاسخ به تماس

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

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

    (isAllowedAccess: boolean) => void

    • استAllowedAccess

      بولی

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

برمی گرداند

  • وعده<boolean>

    Chrome 99+

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

sendRequest()

Promise ≤ MV2 منسوخ شده است
 
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

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

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

پارامترها

  • شناسه extension

    رشته اختیاری

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

  • درخواست کنید

    هر

  • پاسخ به تماس

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

    Chrome 99+

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

    (response: any) => void

    • پاسخ

      هر

      شی پاسخ JSON توسط کنترل کننده درخواست ارسال شده است. اگر هنگام اتصال به برنامه افزودنی خطایی رخ دهد، callback بدون آرگومان فراخوانی می شود و runtime.lastError روی پیام خطا تنظیم می شود.

برمی گرداند

  • قول <هر>

    Chrome 99+

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

مقدار پارامتر ap CGI مورد استفاده در URL به‌روزرسانی برنامه افزودنی را تنظیم می‌کند. این مقدار برای برنامه‌های افزودنی که در گالری برنامه افزودنی Chrome میزبانی می‌شوند نادیده گرفته می‌شود.

پارامترها

  • داده ها

    رشته

رویدادها

onRequest

≤ MV2 منسوخ شده است
 
chrome.extension.onRequest.addListener(
  callback: function,
)

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

هنگامی که درخواستی از یک فرآیند افزونه یا یک اسکریپت محتوا ارسال می شود، فعال می شود.

پارامترها

  • پاسخ به تماس

    تابع

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

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

    • درخواست کنید

      هر

    • فرستنده

      runtime.MessageSender

    • sendResponse

      تابع

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

      () => void

onRequestExternal

≤ MV2 منسوخ شده است
 
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

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

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

پارامترها

  • پاسخ به تماس

    تابع

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

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

    • درخواست کنید

      هر

    • فرستنده

      runtime.MessageSender

    • sendResponse

      تابع

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

      () => void