chrome.webNavigation

תיאור

יש להשתמש ב-API chrome.webNavigation כדי לקבל התראות לגבי הסטטוס של בקשות ניווט בזמן שהן פועלות.

הרשאות

webNavigation

בכל השיטות והאירועים של chrome.webNavigation צריך להצהיר על ההרשאה "webNavigation" במניפסט התוספים. למשל:

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

מושגים ושימוש

סדר האירוע

בניווט שהסתיים בהצלחה, האירועים מופעלים לפי הסדר הבא:

onBeforeNavigate -> onCommitted -> [onDOMContentLoaded] -> onCompleted

כל שגיאה שמתרחשת בתהליך מובילה לאירוע onErrorOccurred. בניווט ספציפי, לא יהיו אירועים נוספים שיופעלו אחרי onErrorOccurred.

אם פריים ניווט מכיל מסגרות משנה, onCommitted שלו מופעל לפני כל אחד מonBeforeNavigate הצאצאים שלו, ואילו onCompleted מופעל אחרי כל onCompleted של הצאצא שלו.

אם מקטע ההפניה של מסגרת משתנה, מופעל אירוע onReferenceFragmentUpdated. האירוע הזה יכול לפעול בכל שלב אחרי onDOMContentLoaded, גם אחרי onCompleted.

אם נעשה שימוש ב-History API כדי לשנות את המצב של מסגרת (למשל, באמצעות history.pushState(), מופעל אירוע onHistoryStateUpdated. האירוע הזה יכול לפעול בכל שלב אחרי onDOMContentLoaded.

אם ניווט שחזר דף ממטמון לדף הקודם/הבא, האירוע onDOMContentLoaded לא יופעל. האירוע לא מופעל כי התוכן כבר השלים את הטעינה כשהביקור הראשון בדף.

אם הופעל ניווט באמצעות Chrome ללא התקנה או דפים ללא התקנה, דף שנטען במלואו יוחלף בכרטיסייה הנוכחית. במקרה כזה, האירוע onTabReplaced מופעל.

הקשר לאירועי webRequest

אין סדר מוגדר בין האירועים ב-webRequest API לבין האירועים ב-webNavigation API. ייתכן שאירועי webRequest עדיין יתקבלו עבור מסגרות שכבר התחילו ניווט חדש, או שהניווט ימשיך רק אחרי שמשאבי הרשת כבר נטענים במלואם.

באופן כללי, אירועי webNavigation קשורים באופן הדוק למצב הניווט שמוצג בממשק המשתמש, ואירועי webRequest תואמים למצב של ערימת הרשת, שבדרך כלל אטומה למשתמש.

מזהי כרטיסיות

לא כל כרטיסיות הניווט מתאימות לכרטיסיות בפועל בממשק המשתמש של Chrome, לדוגמה, כרטיסייה שעוברת עיבוד מראש. לא ניתן לגשת לכרטיסיות כאלה באמצעות Tabs API, וגם לא ניתן לבקש מידע עליהן באמצעות קריאה ל-webNavigation.getFrame() או ל-webNavigation.getAllFrames(). אחרי שמחליפים כרטיסייה כזו, מופעל אירוע onTabReplaced וניתן לגשת אליו דרך ממשקי ה-API האלה.

חותמות זמן

חשוב לציין שכמה בעיות טכניות בטיפול של מערכת ההפעלה בתהליכי Chrome שונים, עלולות לגרום להטיה של השעון בין הדפדפן עצמו לתהליכי התוספים. כלומר, מובטח שהמאפיין timeStamp של מאפיין האירוע WebNavigation ב-timeStamp יהיה עקבי פנימי בלבד. השוואת אירוע אחד לאירוע אחר תציג את ההפרש הנכון ביניהם, אבל השוואה ביניהם לזמן הנוכחי בתוך התוסף (למשל באמצעות (new Date()).getTime()) עלולה לספק תוצאות לא צפויות.

מזהי פריימים

ניתן לזהות מסגרות בתוך כרטיסייה באמצעות מזהה מסגרת. מזהה הפריים של המסגרת הראשית הוא תמיד 0, והמזהה של פריימים צאצאים הוא מספר חיובי. אחרי שיוצרים מסמך במסגרת, מזהה המסגרת שלו נשאר קבוע לכל משך החיים של המסמך. החל מגרסה 49 של Chrome, המזהה הזה קבוע לכל משך החיים של המסגרת (בניווטים מרובים).

בגלל האופי מרובה התהליכים של Chrome, כרטיסייה עשויה להשתמש בתהליכים שונים כדי לעבד את המקור והיעד של דף אינטרנט. לכן, אם ניווט בתהליך חדש, יכול להיות שיתקבלו אירועים גם מהדף החדש וגם מהדף הישן עד לקבלת הניווט החדש (כלומר, האירוע onCommitted נשלח לפריים הראשי החדש). במילים אחרות, יכול להיות יותר מרצף בהמתנה אחד של אירועי WebNavigation עם אותו frameId. ניתן להבחין בין הרצפים באמצעות המפתח processId.

כמו כן, שימו לב שבמהלך טעינה זמנית, התהליך עשוי להשתנות כמה פעמים. הדבר קורה כשהטעינה מופנית לאתר אחר. במקרה כזה, יתקבלו אירועי onBeforeNavigate ו-onErrorOccurred חוזרים, עד לקבלת האירוע האחרון של onCommitted.

מושג נוסף שבעייתי בתוספים הוא מחזור החיים של המסגרת. מסגרת מארחת מסמך (שמשויך לכתובת URL שאתם מחויבים לה). המסמך יכול להשתנות (למשל על ידי ניווט), אבל frameId לא ישתנה, ולכן קשה לשייך שמשהו קרה במסמך ספציפי באמצעות frameIds בלבד. אנחנו משיקים קונספט של documentId, שהוא מזהה ייחודי לכל מסמך. כשמנווטים במסמך חדש ופותחים מסמך חדש, המזהה משתנה. השדה הזה שימושי כדי לקבוע מתי דפים משנים את המצב של מחזור החיים שלהם (בין עיבוד מראש/פעיל/מטמון) כי הוא נשאר ללא שינוי.

סוגים ומאפייני מעבר

לאירוע onCommitted של webNavigation יש את המאפיינים transitionType ו-transitionQualifiers. סוג ההעברה זהה לזה שבו נעשה שימוש ב-history API שמתאר איך הדפדפן עבר לכתובת ה-URL המסוימת הזו. בנוסף, אפשר להחזיר כמה מזהי מעבר שיגדירו עוד יותר את הניווט.

מאפייני המעבר הבאים קיימים:

תוחם מעבר	תיאור
"client_redirect"	כתובת אתר אחת או יותר להפניה מחדש שנגרמו על ידי תגי JavaScript או מטא רענון בדף התרחשה במהלך הניווט.
"server_redirect"	הפניה אחת או יותר נגרמה על ידי כותרות HTTP שנשלחו מהשרת במהלך הניווט.
"forward_back"	המשתמש השתמש בלחצן 'הבא' או 'הקודם' כדי להתחיל את הניווט.
'from_address_bar'	המשתמש הפעיל את הניווט מסרגל הכתובות (שנקרא גם 'סרגל הכתובות').

דוגמאות

כדי לנסות את ה-API הזה, מתקינים את הדוגמה של webNavigation API מהמאגר chrome-extension-samples.

סוגים

TransitionQualifier

Chrome 44 ואילך

טיפוסים בני מנייה (enum)

"client_redirect"

"server_redirect"

"forward_back"

"from_address_bar"

TransitionType

Chrome 44 ואילך

סיבת הניווט. נעשה שימוש באותם סוגי מעברים שמוגדרים ב-History API. סוגי המעבר האלה זהים לאלה שמוגדרים ב-history API, מלבד "start_page" במקום "auto_toplevel" (לתאימות לאחור).

טיפוסים בני מנייה (enum)

"auto_bookmark"

"auto_subframe"

"start_page"

"form_submit"

"keyword_generated"

שיטות

getAllFrames()

הבטחה

chrome.webNavigation.getAllFrames(
  details: object,
  callback?: function,
)

מאחזרת מידע על כל המסגרות של כרטיסייה נתונה.

פרמטרים

• פרטים

  אובייקט

  מידע על הכרטיסייה שמהן יש לאחזר את כל המסגרות.

  • tabId

    מספר

    מזהה הכרטיסייה.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (details?: object[])=>void

  • פרטים

    אובייקט[] אופציונלי

    רשימת המסגרות בכרטיסייה הנתונה, הערך null הוא אם מזהה הכרטיסייה שצוין אינו חוקי.

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • errorOccurred

      boolean

      True אם הניווט האחרון במסגרת הזו הופסק על ידי שגיאה, כלומר, האירוע onErrorOccurred הופעל.

    • frameId

      מספר

      המזהה של המסגרת. 0 מציין שזו המסגרת הראשית. ערך חיובי מציין את המזהה של תת-מסגרת.

    • frameType

      FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • כתובת אתר

      מחרוזת

      כתובת ה-URL שמשויכת כרגע למסגרת הזו.

החזרות

• Promise<object[]|undefined>

  Chrome 93 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

getFrame()

הבטחה

chrome.webNavigation.getFrame(
  details: object,
  callback?: function,
)

שולפת מידע על המסגרת הנתונה. מסגרת מתייחסת לרכיב <iframe> או <frame> של דף אינטרנט, והיא מזוהה באמצעות מזהה כרטיסייה ומזהה מסגרת.

פרמטרים

• פרטים

  אובייקט

  מידע על המסגרת שרוצים לאחזר עליה מידע.

  • documentId

    מחרוזת אופציונלי

    Chrome 106 ומעלה

    ה-UUID של המסמך. אם תספקו את ה-frameId או ה-tabId, הם יאומתו כדי שיתאימו למסמך שיימצא לפי מזהה המסמך שסופק.

  • frameId

    מספר אופציונלי

    המזהה של המסגרת בכרטיסייה הנתונה.

  • processId

    מספר אופציונלי

    הוצא משימוש מאז Chrome 49

    מסגרות מזוהות כעת באופן ייחודי באמצעות מזהה הכרטיסייה ומזהה המסגרת שלהן. אין יותר צורך במזהה התהליך ולכן המערכת מתעלמת מהן.

    המזהה של התהליך שמפעיל את כלי הרינדור עבור הכרטיסייה הזו.

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שבה המסגרת נמצאת.

• קריאה חוזרת (callback)

  פונקציה אופציונלי

  הפרמטר callback נראה כך:

  (details?: object)=>void

  • פרטים

    אובייקט אופציונלי

    מידע על המסגרת המבוקשת, הערך null אם מזהה המסגרת ו/או מזהה הכרטיסייה שצוינו אינם חוקיים.

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • errorOccurred

      boolean

      True אם הניווט האחרון במסגרת הזו הופסק על ידי שגיאה, כלומר, האירוע onErrorOccurred הופעל.

    • frameType

      FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • כתובת אתר

      מחרוזת

      כתובת ה-URL המשויכת כרגע למסגרת הזו, אם המסגרת שמזוהה על ידי ה-frameId הייתה קיימת בנקודה מסוימת בכרטיסייה הנתונה. העובדה שכתובת URL משויכת ל-frameId נתון לא מרמזת על כך שהמסגרת המתאימה עדיין קיימת.

החזרות

• Promise<object|undefined>

  Chrome 93 ומעלה

  יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.

אירועים

onBeforeNavigate

chrome.webNavigation.onBeforeNavigate.addListener(
  callback: function,
  filters?: object,
)

מופעל כשניווט עומד להתרחש.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים לכרטיסייה ולתהליך נתונים.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      הוצא משימוש מאז Chrome 50

      מזהה התהליך כבר לא מוגדר לאירוע הזה, כי התהליך של עיבוד המסמך שיתקבל לא ידוע עד ל-OnCommit.

      הערך של 1-.

    • tabId

      מספר

      מזהה הכרטיסייה שבה הניווט עומד להתרחש.

    • timeStamp

      מספר

      הזמן שבו הדפדפן עמד להתחיל את הניווט, באלפיות השנייה מאז תחילת התהליך.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onCommitted

chrome.webNavigation.onCommitted.addListener(
  callback: function,
  filters?: object,
)

מופעל כשהניווט נדרש. יכול להיות שמתבצעת הורדה של המסמך (והמשאבים שאליהם הוא מתייחס, כמו תמונות ומסגרות משנה) עדיין, אבל לפחות חלק מהמסמך התקבל מהשרת והדפדפן החליט לעבור למסמך החדש.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו הניווט בוצע, באלפיות השנייה מאז תחילת התקופה של זמן מערכת.

    • transitionQualifiers

      TransitionQualifier[]

      רשימה של מגדירים מעבר.

    • transitionType

      TransitionType

      סיבת הניווט.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onCompleted

chrome.webNavigation.onCompleted.addListener(
  callback: function,
  filters?: object,
)

מופעל כשמסמך, כולל המשאבים שאליהם הוא מתייחס, נטען ומאתחל במלואו.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו המסמך סיים להיטען, באלפיות השנייה מאז תחילת התקופה.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onCreatedNavigationTarget

chrome.webNavigation.onCreatedNavigationTarget.addListener(
  callback: function,
  filters?: object,
)

מופעל כשחלון חדש או כרטיסייה חדשה בחלון קיים נוצרים כדי לארח ניווט.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • sourceFrameId

      מספר

      המזהה של המסגרת עם sourceTabId שהניווט מופעל בה. 0 מציין את המסגרת הראשית.

    • sourceProcessId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת המקור.

    • sourceTabId

      מספר

      המזהה של הכרטיסייה שבה הניווט מופעל.

    • tabId

      מספר

      מזהה הכרטיסייה שבה כתובת ה-URL נפתחה

    • timeStamp

      מספר

      הזמן שבו הדפדפן עמד ליצור תצוגה חדשה, באלפיות השנייה מאז תחילת התהליך.

    • כתובת אתר

      מחרוזת

      כתובת ה-URL שתיפתח בחלון החדש.

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onDOMContentLoaded

chrome.webNavigation.onDOMContentLoaded.addListener(
  callback: function,
  filters?: object,
)

מופעל כשה-DOM של הדף בנוי במלואו, אבל ייתכן שהמשאבים שאליהם מתבצעת ההפניה לא מסתיימת.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו ה-DOM של הדף נבנה במלואו, באלפיות השנייה מאז תחילתו של תהליך היצירה.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onErrorOccurred

chrome.webNavigation.onErrorOccurred.addListener(
  callback: function,
  filters?: object,
)

מופעל כשמתרחשת שגיאה והניווט מתבטל. מצב כזה יכול לקרות אם אירעה שגיאת רשת או שהמשתמש ביטל את הניווט.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • error

      מחרוזת

      תיאור השגיאה.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      הוצא משימוש מאז Chrome 50

      מזהה התהליך כבר לא מוגדר לאירוע הזה.

      הערך של 1-.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו אירעה השגיאה, באלפיות השנייה מאז תחילת התהליך.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onHistoryStateUpdated

chrome.webNavigation.onHistoryStateUpdated.addListener(
  callback: function,
  filters?: object,
)

מופעל כשהיסטוריית המסגרת עודכנה לכתובת URL חדשה. כל האירועים העתידיים של אותה מסגרת ישתמשו בכתובת ה-URL המעודכנת.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו הניווט בוצע, באלפיות השנייה מאז תחילת התקופה של זמן מערכת.

    • transitionQualifiers

      TransitionQualifier[]

      רשימה של מגדירים מעבר.

    • transitionType

      TransitionType

      סיבת הניווט.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onReferenceFragmentUpdated

chrome.webNavigation.onReferenceFragmentUpdated.addListener(
  callback: function,
  filters?: object,
)

הופעל כשמקטע ההפניה של המסגרת עודכן. כל האירועים העתידיים של אותה מסגרת ישתמשו בכתובת ה-URL המעודכנת.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • documentId

      מחרוזת

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של המסמך שנטען.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome 106 ומעלה

      מחזור החיים של המסמך.

    • frameId

      מספר

      הערך 0 מציין שהניווט מתרחש בחלון של תוכן הכרטיסייה, וערך חיובי מציין ניווט במסגרת תת-מסגרת. מזהי המסגרות הם ייחודיים בכרטיסייה.

    • frameType

      extensionTypes.FrameType

      Chrome 106 ומעלה

      סוג המסגרת שבה התרחש הניווט.

    • parentDocumentId

      מחרוזת אופציונלי

      Chrome 106 ומעלה

      מזהה ייחודי אוניברסלי (UUID) של מסמך ההורה שהוא הבעלים של המסגרת הזו. הערך לא מוגדר אם אין הורה.

    • parentFrameId

      מספר

      Chrome 74 ומעלה

      המזהה של מסגרת ההורה. אם זו המסגרת הראשית, -1.

    • processId

      מספר

      המזהה של התהליך שמפעיל את הכלי לרינדור למסגרת הזו.

    • tabId

      מספר

      מזהה הכרטיסייה שבה מתבצע הניווט.

    • timeStamp

      מספר

      הזמן שבו הניווט בוצע, באלפיות השנייה מאז תחילת התקופה של זמן מערכת.

    • transitionQualifiers

      TransitionQualifier[]

      רשימה של מגדירים מעבר.

    • transitionType

      TransitionType

      סיבת הניווט.

    • כתובת אתר

      מחרוזת

• מסננים

  אובייקט אופציונלי

  • כתובת אתר

    events.UrlFilter[]

    התנאים שכתובת ה-URL שאליהם מנווטים חייבים לעמוד. באירוע הזה המערכת מתעלמת מהשדות 'chemes' ו-'ports' של UrlFilter.

onTabReplaced

chrome.webNavigation.onTabReplaced.addListener(
  callback: function,
)

מופעל כשתוכן הכרטיסייה מוחלף בכרטיסייה אחרת (שעברה עיבוד מראש בדרך כלל).

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (details: object)=>void

  • פרטים

    אובייקט

    • replacedTabId

      מספר

      המזהה של הכרטיסייה שהוחלפה.

    • tabId

      מספר

      המזהה של הכרטיסייה שהחליפה את הכרטיסייה הישנה.

    • timeStamp

      מספר

      הזמן שבו התרחשה ההחלפה, באלפיות השנייה מאז תחילת התהליך.