chrome.webNavigation

תיאור

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

הרשאות

webNavigation

מניפסט

בכל השיטות והאירועים של chrome.webNavigation, נדרשת הצהרה על 'ניווט באינטרנט' הרשאה במניפסט התוסף. לדוגמה:

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

סדר האירוע

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

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

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

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

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

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

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

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

קשר לאירועים ב-webRequest

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

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

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

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

חותמות זמן

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

מזהי פריימים

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

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

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

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

סוגי מעבר ופרמטרים ספציפיים

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

ערכי המעבר הבאים קיימים:

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

דוגמאות

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

סוגים

TransitionQualifier

Chrome 44 ואילך

Enum

"client_redirect"

"server_redirect"

"קדימה_back"

"from_address_bar"

TransitionType

Chrome 44 ואילך

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

Enum

"link"

"typed"

"auto_bookmark"

"auto_subframe"

" manual_subframe"

"נוצר"

"start_page"

"form_submit"

"טעינה מחדש"

"מילת מפתח"

"keyword_generated"

שיטות

getAllFrames()

הבטחה
chrome.webNavigation.getAllFrames(
  details: object,
  callback?: function,
)

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

פרמטרים

  • פרטים

    אובייקט

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

    • tabId

      number

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

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

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

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

    (details?: object[]) => void

    • פרטים

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

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

      • documentId

        מחרוזת

        Chrome 106+

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

      • documentLifecycle
        Chrome 106+

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

      • errorOccurred

        בוליאני

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

      • frameId

        number

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

      • frameType
        Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

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

      • processId

        number

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

      • כתובת אתר

        מחרוזת

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

החזרות

  • Promise<object[] | לא מוגדר>

    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
        Chrome 106+

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

      • errorOccurred

        בוליאני

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

      • frameType
        Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

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

      • כתובת אתר

        מחרוזת

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

החזרות

  • Promise&lt;object | לא מוגדר>

    Chrome מגרסה 93 ואילך

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

אירועים

onBeforeNavigate

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

מופעל כשמתבצע ניווט.

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

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

      • processId

        number

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

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

        הערך של 1-.

      • tabId

        number

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

      • timeStamp

        number

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

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onCommitted

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • transitionQualifiers

        רשימה של הגדרות מעבר.

      • transitionType

        הסיבה לניווט.

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onCompleted

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onCreatedNavigationTarget

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • sourceFrameId

        number

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

      • sourceProcessId

        number

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

      • sourceTabId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • כתובת אתר

        מחרוזת

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

  • מסננים

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

    • כתובת אתר

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

onDOMContentLoaded

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onErrorOccurred

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • error

        מחרוזת

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

        ה-ProcessId כבר לא מוגדר לאירוע הזה.

        הערך של 1-.

      • tabId

        number

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

      • timeStamp

        number

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

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onHistoryStateUpdated

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • transitionQualifiers

        רשימה של הגדרות מעבר.

      • transitionType

        הסיבה לניווט.

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onReferenceFragmentUpdated

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • documentId

        מחרוזת

        Chrome 106+

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

      • Chrome 106+

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

      • frameId

        number

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

      • Chrome 106+

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

      • parentDocumentId

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

        Chrome 106+

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

      • parentFrameId

        number

        Chrome מגרסה 74 ואילך

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

      • processId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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

      • transitionQualifiers

        רשימה של הגדרות מעבר.

      • transitionType

        הסיבה לניווט.

      • כתובת אתר

        מחרוזת

  • מסננים

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

    • כתובת אתר

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

onTabReplaced

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

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

פרמטרים

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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • replacedTabId

        number

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

      • tabId

        number

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

      • timeStamp

        number

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