توضیحات
توجه: این API منسوخ شده است. در عوض declarativeNetRequest
API را بررسی کنید. از chrome.declarativeWebRequest
API برای رهگیری، مسدود کردن یا تغییر درخواست ها در حین پرواز استفاده کنید. این به طور قابل توجهی سریعتر از chrome.webRequest
API است زیرا می توانید قوانینی را که در مرورگر ارزیابی می شوند به جای موتور جاوا اسکریپت ثبت کنید، که تاخیرهای رفت و برگشت را کاهش می دهد و کارایی بالاتری را ممکن می کند.
مجوزها
declarativeWebRequest
برای استفاده از این API، به همراه مجوزهای میزبان ، باید مجوز "DeclarativeWebRequest" را در مانیفست افزونه اعلام کنید.
{
"name": "My extension",
...
"permissions": [
"declarativeWebRequest",
"*://*/*"
],
...
}
در دسترس بودن
آشکار
توجه داشته باشید که انواع خاصی از اقدامات غیر حساس به مجوز میزبان نیاز ندارند:
-
CancelRequest
-
IgnoreRules
-
RedirectToEmptyDocument
-
RedirectToTransparentImage
عمل SendMessageToExtension()
به مجوزهای میزبان برای هر میزبانی که درخواست شبکه آنها را می خواهید برای راه اندازی یک پیام نیاز دارد.
همه اقدامات دیگر نیاز به مجوز میزبان برای همه URL ها دارند.
به عنوان مثال، اگر "https://*.google.com/*"
تنها مجوز میزبانی باشد که یک برنامه افزودنی دارد، آنگاه چنین برنامه افزودنی ممکن است قانونی را تنظیم کند:
- درخواست به
https://www.google.com
یاhttps://anything.else.com
را لغو کنید. - هنگام پیمایش به
https://www.google.com
پیامی ارسال کنید اما بهhttps://something.else.com
پیامی ارسال نکنید.
برنامه افزودنی نمی تواند قانونی برای هدایت https://www.google.com
به https://mail.google.com
تنظیم کند.
قوانین
Declarative Web Request API از مفاهیم Declarative API پیروی می کند. می توانید قوانین را در شی رویداد chrome.declarativeWebRequest.onRequest
ثبت کنید.
API Declarative Web Request از یک نوع معیار مطابقت پشتیبانی می کند، RequestMatcher
. RequestMatcher
با درخواست های شبکه مطابقت دارد اگر و تنها در صورتی که همه معیارهای فهرست شده برآورده شوند. هنگامی که کاربر https://www.example.com
در ominbox وارد می کند، RequestMatcher
زیر با درخواست شبکه مطابقت دارد:
var matcher = new chrome.declarativeWebRequest.RequestMatcher({
url: { hostSuffix: 'example.com', schemes: ['http'] },
resourceType: ['main_frame']
});
درخواستها به https://www.example.com
به دلیل این طرح توسط RequestMatcher
رد میشوند. همچنین تمام درخواستهای iframe تعبیهشده به دلیل resourceType
رد میشوند.
برای لغو تمام درخواستها به "example.com"، میتوانید یک قانون به صورت زیر تعریف کنید:
var rule = {
conditions: [
new chrome.declarativeWebRequest.RequestMatcher({
url: { hostSuffix: 'example.com' } })
],
actions: [
new chrome.declarativeWebRequest.CancelRequest()
]
};
برای لغو همه درخواستها به example.com
و foobar.com
، میتوانید شرط دوم را اضافه کنید، زیرا هر شرط برای فعال کردن تمام اقدامات مشخص شده کافی است:
var rule2 = {
conditions: [
new chrome.declarativeWebRequest.RequestMatcher({
url: { hostSuffix: 'example.com' } }),
new chrome.declarativeWebRequest.RequestMatcher({
url: { hostSuffix: 'foobar.com' } })
],
actions: [
new chrome.declarativeWebRequest.CancelRequest()
]
};
قوانین ثبت نام به شرح زیر است:
chrome.declarativeWebRequest.onRequest.addRules([rule2]);
ارزیابی شرایط و اقدامات
API Declarative Web Request از مدل چرخه حیات برای درخواستهای وب API Web Request پیروی میکند. این بدان معنی است که شرایط را فقط می توان در مراحل خاصی از یک درخواست وب آزمایش کرد و به همین ترتیب، اقدامات نیز فقط در مراحل خاصی قابل اجرا هستند. جداول زیر مراحل درخواستی را که با شرایط و اقدامات سازگار هستند فهرست می کنند.
درخواست مراحلی که طی آن ویژگیهای شرط میتوانند پردازش شوند. | ||||
---|---|---|---|---|
ویژگی شرط | onBeforeRequest | onBeforeSendHeaders | onHeaders Received | onAuthRequired |
url | ✓ | ✓ | ✓ | ✓ |
resourceType | ✓ | ✓ | ✓ | ✓ |
contentType | ✓ | |||
excludeContentType | ✓ | |||
responseHeaders | ✓ | |||
excludeResponseHeaders | ✓ | |||
requestHeaders | ✓ | |||
excludeRequestHeaders | ✓ | |||
thirdPartyForCookies | ✓ | ✓ | ✓ | ✓ |
درخواست مراحلی که در طی آن اقدامات می توانند اجرا شوند. | ||||
رویداد | onBeforeRequest | onBeforeSendHeaders | onHeaders Received | onAuthRequired |
AddRequestCookie | ✓ | |||
AddResponseCookie | ✓ | |||
AddResponseHeader | ✓ | |||
CancelRequest | ✓ | ✓ | ✓ | ✓ |
EditRequestCookie | ✓ | |||
EditResponseCookie | ✓ | |||
IgnoreRules | ✓ | ✓ | ✓ | ✓ |
RedirectByRegEx | ✓ | ✓ | ||
RedirectRequest | ✓ | ✓ | ||
RedirectToEmptyDocument | ✓ | ✓ | ||
RedirectToTransparentImage | ✓ | ✓ | ||
RemoveRequestCookie | ✓ | |||
RemoveRequestHeader | ✓ | |||
RemoveResponseCookie | ✓ | |||
RemoveResponseHeader | ✓ | |||
SendMessageToExtension | ✓ | ✓ | ✓ | ✓ |
SetRequestHeader | ✓ |
از اولویت ها برای نادیده گرفتن قوانین استفاده کنید
قوانین را می توان با اولویت هایی که در رویدادهای API توضیح داده شده است مرتبط کرد. از این مکانیسم می توان برای بیان استثناها استفاده کرد. مثال زیر تمام درخواستهای تصاویری با نام evil.jpg
را به جز در سرور "myserver.com" مسدود میکند.
var rule1 = {
priority: 100,
conditions: [
new chrome.declarativeWebRequest.RequestMatcher({
url: { pathEquals: 'evil.jpg' } })
],
actions: [
new chrome.declarativeWebRequest.CancelRequest()
]
};
var rule2 = {
priority: 1000,
conditions: [
new chrome.declarativeWebRequest.RequestMatcher({
url: { hostSuffix: '.myserver.com' } })
],
actions: [
new chrome.declarativeWebRequest.IgnoreRules({
lowerPriorityThan: 1000 })
]
};
chrome.declarativeWebRequest.onRequest.addRules([rule1, rule2]);
مهم است که بدانیم عمل IgnoreRules
در تمام مراحل درخواست ادامه ندارد. تمام شرایط همه قوانین در هر مرحله از یک درخواست وب ارزیابی می شود. اگر یک اقدام IgnoreRules
اجرا شود، فقط برای سایر اقداماتی که برای همان درخواست وب در همان مرحله اجرا می شوند، اعمال می شود.
انواع
AddRequestCookie
یک کوکی به درخواست اضافه می کند یا یک کوکی را لغو می کند، در صورتی که کوکی دیگری به همین نام قبلا وجود داشته باشد. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: AddRequestCookie) => {...}
- ارگ
- برمی گرداند
- کوکی
کوکی به درخواست اضافه شود. هیچ فیلدی ممکن است تعریف نشده باشد.
AddResponseCookie
یک کوکی به پاسخ اضافه می کند یا یک کوکی را لغو می کند، در صورتی که کوکی دیگری به همین نام قبلا وجود داشته باشد. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: AddResponseCookie) => {...}
- برمی گرداند
- کوکی
کوکی به پاسخ اضافه می شود. نام و مقدار باید مشخص شود.
AddResponseHeader
هدر پاسخ را به پاسخ این درخواست وب اضافه می کند. از آنجایی که ممکن است چندین سرصفحه پاسخ یک نام داشته باشند، ابتدا باید یک سرصفحه پاسخ جدید را حذف کرده و سپس به منظور جایگزینی آن اضافه کنید.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: AddResponseHeader) => {...}
- برمی گرداند
- نام
رشته
نام سرصفحه پاسخ HTTP.
- ارزش
رشته
مقدار سرصفحه پاسخ HTTP.
CancelRequest
کنش رویداد اعلامی که درخواست شبکه را لغو می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: CancelRequest) => {...}
- ارگ
- برمی گرداند
EditRequestCookie
یک یا چند کوکی درخواستی را ویرایش می کند. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: EditRequestCookie) => {...}
- برمی گرداند
- فیلتر
فیلتر برای کوکی هایی که اصلاح خواهند شد. همه ورودی های خالی نادیده گرفته می شوند.
- اصلاح
ویژگیهایی که باید در کوکیهایی که با فیلتر مطابقت دارند لغو شوند. ویژگی هایی که روی یک رشته خالی تنظیم شده اند حذف می شوند.
EditResponseCookie
یک یا چند کوکی پاسخ را ویرایش می کند. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: EditResponseCookie) => {...}
- برمی گرداند
- فیلتر
فیلتر برای کوکی هایی که اصلاح خواهند شد. همه ورودی های خالی نادیده گرفته می شوند.
- اصلاح
ویژگیهایی که باید در کوکیهایی که با فیلتر مطابقت دارند لغو شوند. ویژگی هایی که روی یک رشته خالی تنظیم شده اند حذف می شوند.
FilterResponseCookie
فیلتر یک کوکی در پاسخ های HTTP.
خواص
- ageLowerBound
شماره اختیاری
کران پایینی شامل طول عمر کوکی (در ثانیه پس از زمان فعلی مشخص شده است). فقط کوکیهایی که تاریخ انقضا زمان آنها روی «اکنون + ageLowerBound» یا بعد از آن تنظیم شده است، این معیار را برآورده میکنند. کوکیهای جلسه با معیار این فیلتر مطابقت ندارند. طول عمر کوکی از ویژگیهای کوکی «حداکثر سن» یا «انقضا» محاسبه میشود. اگر هر دو مشخص شده باشند، از «حداکثر سن» برای محاسبه طول عمر کوکی استفاده می شود.
- ageUpperBound
شماره اختیاری
کران بالایی شامل طول عمر کوکی (در ثانیه پس از زمان فعلی مشخص شده است). فقط کوکیهایی که تاریخ انقضا و زمان آنها در بازه زمانی [اکنون، اکنون + ageUpperBound] است، این معیار را برآورده میکنند. کوکیهای جلسه و کوکیهایی که تاریخ انقضا آنها در گذشته است، معیار این فیلتر را ندارند. طول عمر کوکی از ویژگیهای کوکی «حداکثر سن» یا «انقضا» محاسبه میشود. اگر هر دو مشخص شده باشند، از «حداکثر سن» برای محاسبه طول عمر کوکی استفاده می شود.
- دامنه
رشته اختیاری
مقدار ویژگی کوکی دامنه.
- منقضی می شود
رشته اختیاری
مقدار ویژگی کوکی Expires.
- فقط http
رشته اختیاری
وجود ویژگی کوکی HttpOnly.
- حداکثر سن
شماره اختیاری
مقدار ویژگی کوکی Max-Age
- نام
رشته اختیاری
نام یک کوکی
- مسیر
رشته اختیاری
مقدار ویژگی کوکی مسیر.
- امن
رشته اختیاری
وجود ویژگی کوکی امن.
- sessionCookie
بولی اختیاری
کوکی های جلسه را فیلتر می کند. کوکیهای جلسه در هیچ یک از ویژگیهای «حداکثر سن» یا «انقضا» طول عمر مشخصی ندارند.
- ارزش
رشته اختیاری
مقدار یک کوکی، ممکن است در دو نقل قول اضافه شود.
HeaderFilter
فیلترها برای معیارهای مختلف سرصفحه درخواست می کنند. معیارهای چندگانه به صورت ترکیبی ارزیابی می شوند.
خواص
- نام شامل
رشته | رشته[] اختیاری است
اگر نام سرصفحه شامل تمام رشته های مشخص شده باشد مطابقت دارد.
- nameEquals
رشته اختیاری
اگر نام سرصفحه با رشته مشخص شده برابر باشد مطابقت دارد.
- نام پیشوند
رشته اختیاری
اگر نام سرصفحه با رشته مشخص شده شروع شود مطابقت دارد.
- پسوند name
رشته اختیاری
اگر نام سرصفحه با رشته مشخص شده ختم شود مطابقت دارد.
- ارزش حاوی
رشته | رشته[] اختیاری است
اگر مقدار سرصفحه شامل تمام رشته های مشخص شده باشد، مطابقت دارد.
- ارزش برابر است
رشته اختیاری
اگر مقدار هدر برابر با رشته مشخص شده باشد مطابقت دارد.
- ارزش پیشوند
رشته اختیاری
اگر مقدار هدر با رشته مشخص شده شروع شود مطابقت دارد.
- پسوند ارزش
رشته اختیاری
اگر مقدار سرصفحه با رشته مشخص شده به پایان برسد مطابقت دارد.
IgnoreRules
تمام قوانینی که با معیارهای مشخص شده مطابقت دارند را پوشش می دهد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: IgnoreRules) => {...}
- برمی گرداند
- hasTag
رشته اختیاری
اگر تنظیم شود، قوانین با برچسب مشخص شده نادیده گرفته می شوند. این نادیده گرفتن ادامه نمی یابد، بلکه فقط قوانین و اقدامات آنها در همان مرحله درخواست شبکه را تحت تأثیر قرار می دهد. توجه داشته باشید که قوانین به ترتیب نزولی اولویت های خود اجرا می شوند. این اقدام بر قوانین با اولویت کمتر از قانون فعلی تأثیر می گذارد. قوانین با همان اولویت ممکن است نادیده گرفته شوند یا نشوند.
- اولویت کمتر از
شماره اختیاری
اگر تنظیم شود، قوانین با اولویت کمتر از مقدار مشخص شده نادیده گرفته می شوند. این مرز پایدار نیست، فقط بر قوانین و اقدامات آنها در همان مرحله درخواست شبکه تأثیر می گذارد.
RedirectByRegEx
یک درخواست را با اعمال یک عبارت منظم در URL هدایت می کند. عبارات منظم از نحو RE2 استفاده می کنند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RedirectByRegEx) => {...}
- ارگ
- برمی گرداند
- از
رشته
الگوی تطبیقی که ممکن است حاوی گروههای ضبط باشد. گروههای کپچر در دستور Perl ($1, $2, ...) به جای نحو RE2 (\1, \2, ...) ارجاع داده میشوند تا به عبارتهای منظم جاوا اسکریپت نزدیکتر شوند.
- به
رشته
الگوی مقصد
RedirectRequest
کنش رویداد اعلامی که درخواست شبکه را هدایت می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RedirectRequest) => {...}
- ارگ
- برمی گرداند
- redirectUrl
رشته
مقصد به جایی که درخواست هدایت می شود.
RedirectToEmptyDocument
اقدام رویداد اعلامی که درخواست شبکه را به یک سند خالی هدایت می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RedirectToEmptyDocument) => {...}
- برمی گرداند
RedirectToTransparentImage
کنش رویداد اعلامی که درخواست شبکه را به یک تصویر شفاف هدایت می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RedirectToTransparentImage) => {...}
- برمی گرداند
RemoveRequestCookie
یک یا چند کوکی درخواستی را حذف می کند. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RemoveRequestCookie) => {...}
- برمی گرداند
- فیلتر
فیلتر برای کوکی هایی که حذف خواهند شد. همه ورودی های خالی نادیده گرفته می شوند.
RemoveRequestHeader
هدر درخواست نام مشخص شده را حذف می کند. از SetRequestHeader و RemoveRequestHeader با نام هدر یکسان در یک درخواست استفاده نکنید. نام سرصفحه هر درخواست فقط یک بار در هر درخواست وجود دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RemoveRequestHeader) => {...}
- برمی گرداند
- نام
رشته
نام سرصفحه درخواست HTTP (بدون حساسیت).
RemoveResponseCookie
یک یا چند کوکی پاسخ را حذف می کند. توجه داشته باشید که استفاده از Cookies API ترجیح داده می شود زیرا از نظر محاسباتی هزینه کمتری دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RemoveResponseCookie) => {...}
- برمی گرداند
- فیلتر
فیلتر برای کوکی هایی که حذف خواهند شد. همه ورودی های خالی نادیده گرفته می شوند.
RemoveResponseHeader
تمام هدرهای پاسخ نام ها و مقادیر مشخص شده را حذف می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RemoveResponseHeader) => {...}
- برمی گرداند
- نام
رشته
نام سرصفحه درخواست HTTP (بدون حساسیت).
- ارزش
رشته اختیاری
مقدار سرصفحه درخواست HTTP (بدون حساسیت).
RequestCookie
فیلتر یا مشخصات یک کوکی در درخواست های HTTP.
خواص
- نام
رشته اختیاری
نام یک کوکی
- ارزش
رشته اختیاری
مقدار یک کوکی، ممکن است در دو نقل قول اضافه شود.
RequestMatcher
رویدادهای شبکه را با معیارهای مختلف مطابقت می دهد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: RequestMatcher) => {...}
- ارگ
- برمی گرداند
- نوع محتوا
رشته[] اختیاری است
در صورتی مطابقت دارد که نوع رسانه MIME یک پاسخ (از سرصفحه نوع محتوای HTTP) در لیست موجود باشد.
- excludeContentType
رشته[] اختیاری است
در صورتی مطابقت دارد که نوع رسانه MIME یک پاسخ (از سرصفحه نوع محتوای HTTP) در لیست موجود نباشد .
- excludeRequestHeaders
HeaderFilter [] اختیاری است
اگر هیچ یک از سرصفحه های درخواست با هیچ یک از HeaderFilters مطابقت نداشته باشد مطابقت دارد.
- ExcludeResponseHeaders
HeaderFilter [] اختیاری است
اگر هیچ یک از سرصفحه های پاسخ با هیچ یک از HeaderFilters مطابقت نداشته باشد، مطابقت دارد.
- firstPartyForCookiesUrl
UrlFilter اختیاری است
منسوخ شده استاز زمان انتشار 82 نادیده گرفته شد.
در صورتی مطابقت دارد که شرایط UrlFilter برای URL "طرف اول" درخواست برآورده شده باشد. نشانی وب «شخص اول» درخواست، در صورت وجود، میتواند با نشانی وب هدف درخواست متفاوت باشد و آنچه را که «شخص اول» در نظر گرفته میشود برای بررسی کوکیها توسط شخص ثالث توصیف میکند.
- درخواست سرصفحه ها
HeaderFilter [] اختیاری است
اگر برخی از سرصفحه های درخواست با یکی از HeaderFilters مطابقت داشته باشند، مطابقت دارد.
- نوع منبع
نوع منبع [] اختیاری است
در صورتی مطابقت دارد که نوع درخواست یک درخواست در لیست موجود باشد. درخواست هایی که نمی توانند با هیچ یک از انواع مطابقت داشته باشند، فیلتر می شوند.
- پاسخ سرصفحه ها
HeaderFilter [] اختیاری است
اگر برخی از سرصفحههای پاسخ با یکی از HeaderFilters مطابقت داشته باشند، مطابقت دارد.
- مراحل
مرحله [] اختیاری است
شامل فهرستی از رشتههایی است که مراحل را توصیف میکنند. مقادیر مجاز عبارتند از 'onBeforeRequest'، 'onBeforeSendHeaders'، 'onHeadersReceived'، 'onAuthRequired'. اگر این ویژگی وجود داشته باشد، مراحل قابل اجرا را به موارد ذکر شده محدود می کند. توجه داشته باشید که کل شرط فقط در مراحل سازگار با همه ویژگی ها قابل اجرا است.
- thirdPartyForCookies
بولی اختیاری
منسوخ شده استاز زمان انتشار 87 نادیده گرفته شده است.
اگر روی درست تنظیم شود، با درخواستهایی مطابقت دارد که مشمول خطمشیهای کوکی شخص ثالث هستند. اگر روی false تنظیم شود، با تمام درخواستهای دیگر مطابقت دارد.
- آدرس اینترنتی
UrlFilter اختیاری است
مطابق با شرایط UrlFilter برای URL درخواست است.
ResponseCookie
مشخصات یک کوکی در پاسخ های HTTP.
خواص
- دامنه
رشته اختیاری
مقدار ویژگی کوکی دامنه.
- منقضی می شود
رشته اختیاری
مقدار ویژگی کوکی Expires.
- فقط http
رشته اختیاری
وجود ویژگی کوکی HttpOnly.
- حداکثر سن
شماره اختیاری
مقدار ویژگی کوکی Max-Age
- نام
رشته اختیاری
نام یک کوکی
- مسیر
رشته اختیاری
مقدار ویژگی کوکی مسیر.
- امن
رشته اختیاری
وجود ویژگی کوکی امن.
- ارزش
رشته اختیاری
مقدار یک کوکی، ممکن است در دو نقل قول اضافه شود.
SendMessageToExtension
رویداد declarativeWebRequest.onMessage
را فعال می کند.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: SendMessageToExtension) => {...}
- برمی گرداند
- پیام
رشته
مقداری که در ویژگی
message
فرهنگ لغت که به کنترل کننده رویداد ارسال می شود، ارسال می شود.
SetRequestHeader
هدر درخواست نام مشخص شده را روی مقدار مشخص شده تنظیم می کند. اگر هدر با نام مشخص شده قبلا وجود نداشت، یک سرصفحه جدید ایجاد می شود. مقایسه نام سرصفحه همیشه به حروف بزرگ و کوچک حساس نیست. نام سرصفحه هر درخواست فقط یک بار در هر درخواست وجود دارد.
خواص
- سازنده
باطل
تابع
constructor
به صورت زیر است:(arg: SetRequestHeader) => {...}
- ارگ
- برمی گرداند
- نام
رشته
نام سرصفحه درخواست HTTP.
- ارزش
رشته
مقدار سرصفحه درخواست HTTP.
Stage
Enum
"در قبل از درخواست" "onBeforeSendHeaders" "onHeadersReceived" "onAuthRequired"
رویدادها
onMessage
chrome.declarativeWebRequest.onMessage.addListener(
callback: function,
)
هنگامی که پیامی از طریق declarativeWebRequest.SendMessageToExtension
از یک عملکرد API درخواست وب اعلامی ارسال می شود، فعال می شود.
پارامترها
- پاسخ به تماس
تابع
پارامتر
callback
به نظر می رسد:(details: object) => void
- جزئیات
شی
- شناسه سند
رشته اختیاری
UUID سندی که درخواست را ارائه کرده است.
- documentLifecycle
چرخه عمر سند در آن است.
- frameId
شماره
مقدار 0 نشان می دهد که درخواست در فریم اصلی اتفاق می افتد. یک مقدار مثبت نشان دهنده شناسه زیرفریمی است که درخواست در آن انجام می شود. اگر سند یک قاب (زیر) بارگذاری شود (
type
main_frame
یاsub_frame
است)،frameId
نشان دهنده شناسه این قاب است، نه شناسه قاب بیرونی. شناسههای فریم در یک برگه منحصربهفرد هستند. - نوع قاب
نوع کادری که پیمایش در آن انجام شده است.
- پیام
رشته
پیام ارسال شده توسط اسکریپت فراخوان.
- روش
رشته
روش استاندارد HTTP
- parentDocumentId
رشته اختیاری
UUID سند والد مالک این قاب. اگر والد وجود نداشته باشد، این تنظیم نشده است.
- parentFrameId
شماره
شناسه فریمی که فریمی را که درخواست ارسال کرده است میپیچد. اگر فریم والد وجود نداشته باشد، روی -1 تنظیم کنید.
- درخواست شناسه
رشته
شناسه درخواست شناسه های درخواست در یک جلسه مرورگر منحصر به فرد هستند. در نتیجه، آنها می توانند برای ارتباط دادن رویدادهای مختلف یک درخواست استفاده شوند.
- مرحله
مرحله درخواست شبکه که طی آن رویداد راه اندازی شد.
- tabId
شماره
شناسه برگه ای که درخواست در آن انجام می شود. اگر درخواست مربوط به یک برگه نیست، روی -1 تنظیم کنید.
- مهر زمان
شماره
زمانی که این سیگنال فعال می شود، بر حسب میلی ثانیه از آن دوران.
نحوه استفاده از منبع درخواستی
- آدرس اینترنتی
رشته
onRequest
API Declarative Event متشکل از addRules
، removeRules
و getRules
را ارائه می دهد.