תאריך הרענון: 2026-09-25 robots: noindex
תיאור
הערה: ממשק ה-API הזה הוצא משימוש. אפשר לעיין במקום זאת ב-API של declarativeNetRequest. אפשר להשתמש ב-chrome.declarativeWebRequest API כדי ליירט, לחסום או לשנות בקשות בזמן שהן בטיסה. היא מהירה משמעותית מ-chrome.webRequest API כי אפשר לרשום כללים שמוערכים בדפדפן ולא במנוע JavaScript, מה שמקצר את זמן האחזור של הלוך ושוב ומאפשר יעילות גבוהה יותר.
הרשאות
declarativeWebRequestכדי להשתמש ב-API הזה, צריך להצהיר על ההרשאה declarativeWebRequest במניפסט התוסף, וגם על הרשאות מארח.
{
"name": "My extension",
...
"permissions": [
"declarativeWebRequest",
"*://*/*"
],
...
}
זמינות
מניפסט
שימו לב: סוגים מסוימים של פעולות לא רגישות לא דורשים הרשאות מארח:
CancelRequestIgnoreRulesRedirectToEmptyDocumentRedirectToTransparentImage
הפעולה 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.
כללים
ממשק ה-API של בקשות רשת דקלרטיביות פועל לפי העקרונות של ממשק ה-API הדקלרטיבי. אפשר לרשום כללים באובייקט האירוע chrome.declarativeWebRequest.onRequest.
ה-API של בקשות אינטרנט הצהרתיות תומך בסוג אחד של קריטריון התאמה, RequestMatcher. התנאי RequestMatcher תואם לבקשות מהרשת אם ורק אם מתקיימים כל הקריטריונים שמופיעים ברשימה. הדוגמה הבאה של RequestMatcher תתאים לבקשה לאחזור מהרשת כשהמשתמש יזין https://www.example.com בסרגל הכתובות:
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]);
הערכה של תנאים ופעולות
Declarative Web Request API פועל לפי מודל מחזור החיים לבקשות אינטרנט של Web Request API. המשמעות היא שאפשר לבדוק תנאים רק בשלבים ספציפיים של בקשה לאחזור מהרשת, וכך גם לגבי פעולות – אפשר לבצע אותן רק בשלבים ספציפיים. בטבלאות הבאות מפורטים שלבי הבקשה שתואמים לתנאים ולפעולות.
| שלבי הבקשה שבהם אפשר לעבד מאפייני תנאים. | ||||
|---|---|---|---|---|
| מאפיין התנאי | onBeforeRequest | onBeforeSendHeaders | onHeadersReceived | onAuthRequired |
url |
✓ | ✓ | ✓ | ✓ |
resourceType |
✓ | ✓ | ✓ | ✓ |
contentType |
✓ | |||
excludeContentType |
✓ | |||
responseHeaders |
✓ | |||
excludeResponseHeaders |
✓ | |||
requestHeaders |
✓ | |||
excludeRequestHeaders |
✓ | |||
thirdPartyForCookies |
✓ | ✓ | ✓ | ✓ |
| שלבי הבקשה שבמהלכם אפשר לבצע פעולות. | ||||
| אירוע | onBeforeRequest | onBeforeSendHeaders | onHeadersReceived | onAuthRequired |
AddRequestCookie |
✓ | |||
AddResponseCookie |
✓ | |||
AddResponseHeader |
✓ | |||
CancelRequest |
✓ | ✓ | ✓ | ✓ |
EditRequestCookie |
✓ | |||
EditResponseCookie |
✓ | |||
IgnoreRules |
✓ | ✓ | ✓ | ✓ |
RedirectByRegEx |
✓ | ✓ | ||
RedirectRequest |
✓ | ✓ | ||
RedirectToEmptyDocument |
✓ | ✓ | ||
RedirectToTransparentImage |
✓ | ✓ | ||
RemoveRequestCookie |
✓ | |||
RemoveRequestHeader |
✓ | |||
RemoveResponseCookie |
✓ | |||
RemoveResponseHeader |
✓ | |||
SendMessageToExtension |
✓ | ✓ | ✓ | ✓ |
SetRequestHeader |
✓ | |||
שימוש בעדיפויות כדי לשנות כללים
אפשר לשייך כללים לעדיפויות כמו שמתואר ב-Events 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
הוספת קובץ Cookie לבקשה או החלפה של קובץ Cookie, במקרה שקובץ Cookie אחר עם אותו שם כבר קיים. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: AddRequestCookie) => {...}
-
arg
-
החזרות
-
-
קובץ Cookie
קובץ ה-Cookie שרוצים להוסיף לבקשה. אף שדה לא יכול להיות לא מוגדר.
AddResponseCookie
הוספה של קובץ Cookie לתגובה או החלפה של קובץ Cookie, במקרה שכבר קיים קובץ Cookie עם אותו שם. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: AddResponseCookie) => {...}
-
החזרות
-
-
קובץ Cookie
קובץ Cookie שיוסף לתשובה. צריך לציין את השם והערך.
AddResponseHeader
מוסיף את כותרת התגובה לתגובה של בקשה לאחזור מהרשת הזו. יכול להיות שלכמה כותרות תגובה יש את אותו שם, ולכן כדי להחליף כותרת תגובה צריך קודם להסיר אותה ואז להוסיף כותרת תגובה חדשה.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: AddResponseHeader) => {...}
-
החזרות
-
-
שם
מחרוזת
שם כותרת תגובת ה-HTTP.
-
ערך
מחרוזת
ערך כותרת תגובת HTTP.
CancelRequest
פעולת אירוע דקלרטיבית שמבטלת בקשה לאחזור מהרשת.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: CancelRequest) => {...}
-
arg
-
החזרות
-
EditRequestCookie
עריכה של עוגייה אחת או יותר בבקשה. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: EditRequestCookie) => {...}
-
החזרות
-
-
סינון
מסננים את קובצי ה-Cookie שיש לשנות. המערכת מתעלמת מכל הערכים הריקים.
-
שינוי
מאפיינים שיוחלפו בקובצי Cookie שתואמים למסנן. מאפיינים שמוגדרים כמחרוזת ריקה מוסרים.
EditResponseCookie
עריכה של קובץ Cookie אחד או יותר של התשובה. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: EditResponseCookie) => {...}
-
החזרות
-
-
סינון
מסננים את קובצי ה-Cookie שיש לשנות. המערכת מתעלמת מכל הערכים הריקים.
-
שינוי
מאפיינים שיוחלפו בקובצי Cookie שתואמים למסנן. מאפיינים שמוגדרים כמחרוזת ריקה מוסרים.
FilterResponseCookie
מסנן של קובץ Cookie בתגובות HTTP.
מאפיינים
-
ageLowerBound
מספר אופציונלי
הגבול התחתון של משך החיים של קובץ ה-Cookie (בשניות אחרי השעה הנוכחית). רק קובצי Cookie שתאריך התפוגה שלהם מוגדר ל 'עכשיו + ageLowerBound' או מאוחר יותר עומדים בקריטריון הזה. קובצי Cookie של סשנים לא עומדים בקריטריון של המסנן הזה. משך החיים של קובץ ה-Cookie מחושב לפי המאפיינים max-age או expires של קובץ ה-Cookie. אם מציינים את שניהם, המערכת משתמשת בערך של max-age כדי לחשב את משך החיים של קובץ ה-Cookie.
-
ageUpperBound
מספר אופציונלי
הגבול העליון של משך החיים של קובץ ה-Cookie (כולל), שצוין בשניות אחרי השעה הנוכחית. רק קובצי Cookie שתאריך התפוגה שלהם נמצא בטווח [הזמן הנוכחי, הזמן הנוכחי + ageUpperBound] עומדים בקריטריון הזה. קובצי Cookie זמניים וקובצי Cookie שתאריך התפוגה שלהם חלף לא עומדים בקריטריון של המסנן הזה. משך החיים של קובץ ה-Cookie מחושב לפי המאפיינים max-age או expires של קובץ ה-Cookie. אם מציינים את שניהם, המערכת משתמשת בערך של max-age כדי לחשב את משך החיים של קובץ ה-Cookie.
-
דומיין
מחרוזת אופציונלי
הערך של מאפיין קובץ ה-Cookie של הדומיין.
-
בתוקף עד
מחרוזת אופציונלי
הערך של מאפיין קובץ ה-Cookie Expires.
-
httpOnly
מחרוזת אופציונלי
קיום של מאפיין קובץ Cookie מסוג HttpOnly.
-
maxAge
מספר אופציונלי
הערך של מאפיין קובץ ה-Cookie Max-Age
-
שם
מחרוזת אופציונלי
השם של קובץ Cookie.
-
נתיב
מחרוזת אופציונלי
הערך של מאפיין הנתיב של קובץ ה-Cookie.
-
מאובטח
מחרוזת אופציונלי
המאפיין Secure של קובץ ה-Cookie קיים.
-
sessionCookie
boolean אופציונלי
מסנן קובצי Cookie זמניים. לקובצי Cookie של סשן לא מוגדר זמן חיים באף אחד מהמאפיינים max-age או expires.
-
ערך
מחרוזת אופציונלי
הערך של קובץ Cookie, יכול להיות מרופד במירכאות כפולות.
HeaderFilter
מסנן את כותרות הבקשות לפי קריטריונים שונים. כמה קריטריונים נבדקים כחיבור.
מאפיינים
-
nameContains
string | string[] אופציונלי
תהיה התאמה אם שם הכותרת מכיל את כל המחרוזות שצוינו.
-
nameEquals
מחרוזת אופציונלי
התנאי מתקיים אם שם הכותרת שווה למחרוזת שצוינה.
-
namePrefix
מחרוזת אופציונלי
התאמה מתבצעת אם שם הכותרת מתחיל במחרוזת שצוינה.
-
nameSuffix
מחרוזת אופציונלי
התאמה מתקבלת אם שם הכותרת מסתיים במחרוזת שצוינה.
-
valueContains
string | string[] אופציונלי
ההתאמה מתבצעת אם ערך הכותרת מכיל את כל המחרוזות שצוינו.
-
valueEquals
מחרוזת אופציונלי
התאמה מתבצעת אם ערך הכותרת שווה למחרוזת שצוינה.
-
valuePrefix
מחרוזת אופציונלי
התנאי מתקיים אם ערך הכותרת מתחיל במחרוזת שצוינה.
-
valueSuffix
מחרוזת אופציונלי
התאמה מתקבלת אם ערך הכותרת מסתיים במחרוזת שצוינה.
IgnoreRules
מסתיר את כל הכללים שתואמים לקריטריונים שצוינו.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: IgnoreRules) => {...}
-
arg
-
החזרות
-
-
hasTag
מחרוזת אופציונלי
אם המדיניות הזו מוגדרת, המערכת מתעלמת מכללים עם התג שצוין. ההתעלמות הזו לא נשמרת, והיא משפיעה רק על כללים ועל הפעולות שלהם בשלב של אותה בקשה לאחזור מהרשת. הערה: הכללים מופעלים בסדר יורד לפי העדיפות שלהם. הפעולה הזו משפיעה על כללים עם עדיפות נמוכה יותר מהכלל הנוכחי. יכול להיות שהמערכת תתעלם מכללים עם אותה עדיפות, ויכול להיות שלא.
-
lowerPriorityThan
מספר אופציונלי
אם המדיניות הזו מוגדרת, המערכת מתעלמת מכללים עם עדיפות נמוכה מהערך שצוין. הגבול הזה לא נשמר, והוא משפיע רק על כללים ועל הפעולות שלהם בשלב זהה של בקשה לאחזור מהרשת.
RedirectByRegEx
מפנה בקשה על ידי החלת ביטוי רגולרי על כתובת ה-URL. הביטויים הרגולריים משתמשים בתחביר RE2.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RedirectByRegEx) => {...}
-
arg
-
החזרות
-
-
החל מ-
מחרוזת
תבנית התאמה שיכולה להכיל קבוצות לכידה. הפניות לקבוצות לכידה נעשות בתחביר Perl ($1, $2 וכו') ולא בתחביר RE2 (\1, \2 וכו'), כדי להתקרב לביטויים רגולריים של JavaScript.
-
עד
מחרוזת
תבנית היעד.
RedirectRequest
פעולת אירוע דקלרטיבית שמפנה בקשה לאחזור מהרשת.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RedirectRequest) => {...}
-
arg
-
החזרות
-
-
redirectUrl
מחרוזת
יעד שאליו הבקשה מופנית.
RedirectToEmptyDocument
פעולת אירוע דקלרטיבית שמפנה בקשה לאחזור מהרשת למסמך ריק.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RedirectToEmptyDocument) => {...}
-
החזרות
-
RedirectToTransparentImage
פעולת אירוע דקלרטיבית שמפנה בקשה לאחזור מהרשת לתמונה שקופה.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RedirectToTransparentImage) => {...}
RemoveRequestCookie
מסיר קובץ Cookie אחד או יותר מהבקשה. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RemoveRequestCookie) => {...}
-
החזרות
-
-
סינון
מסננים את קובצי ה-Cookie שיוסרו. המערכת מתעלמת מכל הערכים הריקים.
RemoveRequestHeader
מסיר את כותרת ה-request header עם השם שצוין. אל תשתמשו ב-SetRequestHeader וב-RemoveRequestHeader עם אותו שם כותרת באותה בקשה. כל שם של כותרת בקשה מופיע רק פעם אחת בכל בקשה.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RemoveRequestHeader) => {...}
-
החזרות
-
-
שם
מחרוזת
שם הכותרת של בקשת HTTP (לא תלוי-רישיות).
RemoveResponseCookie
מסיר קובץ Cookie אחד או יותר מהתשובה. שימו לב: מומלץ להשתמש ב-Cookies API כי הוא דורש פחות משאבי מחשוב.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RemoveResponseCookie) => {...}
-
החזרות
-
-
סינון
מסננים את קובצי ה-Cookie שיוסרו. המערכת מתעלמת מכל הערכים הריקים.
RemoveResponseHeader
מסיר את כל כותרות התגובה עם השמות והערכים שצוינו.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RemoveResponseHeader) => {...}
-
החזרות
-
-
שם
מחרוזת
שם הכותרת של בקשת HTTP (לא תלוי-רישיות).
-
ערך
מחרוזת אופציונלי
הערך של כותרת בקשת ה-HTTP (לא תלוי-רישיות).
RequestCookie
מסנן או מפרט של קובץ Cookie בבקשות HTTP.
מאפיינים
-
שם
מחרוזת אופציונלי
השם של קובץ Cookie.
-
ערך
מחרוזת אופציונלי
הערך של קובץ Cookie, יכול להיות מרופד במירכאות כפולות.
RequestMatcher
הפונקציה מתאימה אירועים ברשת לפי קריטריונים שונים.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: RequestMatcher) => {...}
-
arg
-
החזרות
-
-
contentType
string[] אופציונלי
התאמה מתרחשת אם סוג המדיה של MIME בתגובה (מהכותרת HTTP Content-Type) נכלל ברשימה.
-
excludeContentType
string[] אופציונלי
התנאי מתקיים אם סוג המדיה MIME של תגובה (מהכותרת Content-Type של HTTP) לא נכלל ברשימה.
-
excludeRequestHeaders
HeaderFilter[] optional
התאמה מתבצעת אם אף אחת מכותרות הבקשה לא תואמת לאף אחד מהמסננים HeaderFilters.
-
excludeResponseHeaders
HeaderFilter[] optional
התאמה מתרחשת אם אף אחת מכותרות התגובה לא תואמת לאף אחד מהמסננים HeaderFilters.
-
firstPartyForCookiesUrl
UrlFilter אופציונלי
הוצא משימושההגדרה הזו לא רלוונטית מאז גרסה 82.
התאמה מתבצעת אם התנאים של UrlFilter מתקיימים לגבי כתובת ה-URL של 'הצד הראשון' בבקשה. כתובת ה-URL של 'הדומיין הנוכחי' של בקשה, אם היא קיימת, יכולה להיות שונה מכתובת ה-URL של יעד הבקשה, והיא מתארת מה נחשב 'דומיין נוכחי' לצורך בדיקות של קובצי Cookie של צד שלישי.
-
requestHeaders
HeaderFilter[] optional
התאמה מתבצעת אם חלק מכותרות הבקשה תואמות לאחד מ-HeaderFilters.
-
resourceType
ResourceType[] אופציונלי
התאמה מתקבלת אם סוג הבקשה של בקשה מסוימת נכלל ברשימה. בקשות שלא תואמות לאף אחד מהסוגים יסוננו.
-
responseHeaders
HeaderFilter[] optional
התאמה מתבצעת אם חלק מכותרות התגובה תואם לאחד מ-HeaderFilters.
-
שלבים
Stage[] אופציונלי
מכיל רשימה של מחרוזות שמתארות שלבים. הערכים המותרים הם onBeforeRequest, onBeforeSendHeaders, onHeadersReceived ו-onAuthRequired. אם המאפיין הזה מופיע, הוא מגביל את השלבים הרלוונטיים לאלה שמפורטים בו. חשוב לזכור שהתנאי כולו רלוונטי רק לשלבים שתואמים לכל המאפיינים.
-
thirdPartyForCookies
boolean אופציונלי
הוצא משימושהמערכת מתעלמת מההגדרה הזו מגרסה 87.
אם הערך מוגדר כ-True, הבקשות תואמות למדיניות בנושא קובצי Cookie של צד שלישי. אם הערך הוא false, הכלל תואם לכל הבקשות האחרות.
-
url
UrlFilter אופציונלי
התאמה מתבצעת אם התנאים של UrlFilter מתקיימים לגבי כתובת ה-URL של הבקשה.
ResponseCookie
מפרט של קובץ Cookie בתגובות HTTP.
מאפיינים
-
דומיין
מחרוזת אופציונלי
הערך של מאפיין קובץ ה-Cookie של הדומיין.
-
בתוקף עד
מחרוזת אופציונלי
הערך של מאפיין קובץ ה-Cookie Expires.
-
httpOnly
מחרוזת אופציונלי
קיום של מאפיין קובץ Cookie מסוג HttpOnly.
-
maxAge
מספר אופציונלי
הערך של מאפיין קובץ ה-Cookie Max-Age
-
שם
מחרוזת אופציונלי
השם של קובץ Cookie.
-
נתיב
מחרוזת אופציונלי
הערך של מאפיין הנתיב של קובץ ה-Cookie.
-
מאובטח
מחרוזת אופציונלי
קיומו של מאפיין קובץ ה-Cookie Secure.
-
ערך
מחרוזת אופציונלי
הערך של קובץ Cookie, יכול להיות מרופד במירכאות כפולות.
SendMessageToExtension
מפעיל את האירוע declarativeWebRequest.onMessage.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: SendMessageToExtension) => {...}
-
החזרות
-
-
הודעה
מחרוזת
הערך שיועבר במאפיין
messageשל המילון שמועבר לגורם המטפל באירועים.
SetRequestHeader
מגדירים את ה-request header של השם שצוין לערך שצוין. אם לא היה קיים לפני כן כותרת עם השם שצוין, נוצרת כותרת חדשה. ההשוואה של שמות הכותרות היא תמיד לא תלוית-רישיות. כל שם של כותרת בקשה מופיע רק פעם אחת בכל בקשה.
מאפיינים
-
constructor
void
הפונקציה
constructorנראית כך:(arg: SetRequestHeader) => {...}
-
arg
-
החזרות
-
-
שם
מחרוזת
שם הכותרת של בקשת HTTP.
-
ערך
מחרוזת
ערך כותרת בקשת HTTP.
Stage
ספירה
"onBeforeRequest"
"onBeforeSendHeaders"
"onHeadersReceived"
"onAuthRequired"
אירועים
onMessage
chrome.declarativeWebRequest.onMessage.addListener(
callback: function,
)
האירוע מופעל כששולחים הודעה באמצעות declarativeWebRequest.SendMessageToExtension מפעולה של ה-API להצהרת בקשות לאחזור מהרשת.
פרמטרים
-
callback
פונקציה
הפרמטר
callbackנראה כך:(details: object) => void
-
פרטים
אובייקט
-
documentId
מחרוזת אופציונלי
מזהה UUID של המסמך שממנו נשלחה הבקשה.
-
documentLifecycle
מחזור החיים שבו המסמך נמצא.
-
frameId
number
הערך 0 מציין שהבקשה מתרחשת בפריים הראשי, וערך חיובי מציין את המזהה של פריים משני שבו מתרחשת הבקשה. אם המסמך של (מסגרת משנה) נטען (
typeהואmain_frameאוsub_frame),frameIdמציין את המזהה של המסגרת הזו, ולא את המזהה של המסגרת החיצונית. מזהי המסגרות הם ייחודיים בתוך כרטיסייה. -
frameType
סוג המסגרת שבה התרחש הניווט.
-
הודעה
מחרוזת
ההודעה שנשלחה על ידי סקריפט השיחה.
-
method
מחרוזת
שיטת HTTP רגילה.
-
parentDocumentId
מחרוזת אופציונלי
מזהה UUID של מסמך האב שבבעלותו המסגרת הזו. אם אין נכס ראשי, הערך לא מוגדר.
-
parentFrameId
number
המזהה של המסגרת שעוטפת את המסגרת ששלחה את הבקשה. הערך הוא -1 אם לא קיים פריים אב.
-
requestId
מחרוזת
מזהה הבקשה. מזהי הבקשות הם ייחודיים בסשן דפדפן. כתוצאה מכך, אפשר להשתמש בהם כדי לקשר בין אירועים שונים של אותה בקשה.
-
לאחסן נתונים במחסן ביניים (Stage)
השלב של בקשה לאחזור מהרשת שבמהלכו הופעל האירוע.
-
tabId
number
המזהה של הכרטיסייה שבה מתבצעת הבקשה. הערך הוא -1 אם הבקשה לא קשורה לכרטיסייה.
-
timeStamp
number
הזמן שבו האות הזה מופעל, באלפיות השנייה מאז ראשית הזמן.
-
השימוש שייעשה במשאב המבוקש.
-
url
מחרוזת
-
-
onRequest
ה-API מספק את Declarative Event API שכולל את addRules, removeRules ו-getRules.
תנאים
פעולות