chrome.webNavigation

refresh date: 2026-09-25 robots: noindex

شرح

از میانای برنامه‌سازی کاربردی 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.pushState())، رویداد onHistoryStateUpdated فعال می‌شود. این رویداد می‌تواند هرزمان پس‌از onDOMContentLoaded فعال شود.

اگر پیمایش صفحه‌ای را از حافظه نهان ناوبری بین صفحات بازیابی کند، رویداد onDOMContentLoaded اجرا نخواهد شد. رویداد اجرا نمی‌شود زیرا محتوا ازقبل بارگیری را تکمیل کرده است وقتی صفحه برای اولین‌بار بازدید شد.

اگر پیمایش ازطریق Chrome Instant یا Instant Pages راه‌اندازی شده باشد، یک صفحه کاملاً بارشده با برگه فعلی جابه‌جا می‌شود. در این صورت، رویداد onTabReplaced فعال می‌شود.

ارتباط با رویدادهای webRequest

هیچ ترتیب تعریف‌شده‌ای بین رویدادهای webRequest API و رویدادهای webNavigation API وجود ندارد. ممکن است رویدادهای webRequest همچنان برای قاب‌هایی دریافت شود که قبلاً پیمایش جدیدی را شروع کرده‌اند، یا اینکه پیمایش فقط پس‌از بار شدن کامل منابع شبکه ادامه یابد.

به‌طور کلی، رویدادهای webNavigation ارتباط نزدیکی با وضعیت پیمایش نمایش‌داده‌شده در واسط کاربر دارند، درحالی‌که رویدادهای webRequest با وضعیت پشته شبکه مطابقت دارند که معمولاً برای کاربر مبهم است.

شناسه‌های برگه

همه زبانه‌های پیمایش با زبانه‌های واقعی در میانای کاربر Chrome مطابقت ندارند، مثلاً زبانه‌ای که درحال پیش‌پرداز شدن است. چنین برگه‌هایی ازطریق tabs API قابل‌دسترسی نیستند و نمی‌توانید اطلاعات مربوط به آن‌ها را ازطریق webNavigation.getFrame یا webNavigation.getAllFrames درخواست کنید. وقتی چنین برگه‌ای جابه‌جا می‌شود، رویداد onTabReplaced فعال می‌شود و ازطریق این میاناهای برنامه‌سازی کاربردی دردسترس قرار می‌گیرد.

مهرهای زمان

باید توجه داشت که برخی‌از ناهنجاری‌های فنی در مدیریت فرایندهای متمایز Chrome توسط سیستم‌عامل می‌تواند باعث شود ساعت بین خود مرورگر و فرایندهای افزونه کج شود. این یعنی تضمین می‌شود که ویژگی timeStamp رویدادهای WebNavigation فقط ازنظر داخلی سازگار باشد. مقایسه یک رویداد با رویداد دیگر، افست صحیح بین آن‌ها را به شما می‌دهد، اما مقایسه آن‌ها با زمان فعلی در افزونه (مثلاً ازطریق (new Date()).getTime()) ممکن است نتایج غیرمنتظره‌ای به‌همراه داشته باشد.

شناسه‌های قاب

قاب‌های درون برگه را می‌توان با شناسه قاب شناسایی کرد. شناسه قاب اصلی همیشه ۰ است، شناسه قاب‌های فرعی عددی مثبت است. وقتی سندی در قاب ساخته می‌شود، شناسه قاب آن درطول عمر سند ثابت می‌ماند. از Chrome 49، این شناسه برای طول عمر قاب (در چندین پیمایش) نیز ثابت است.

به‌دلیل ماهیت چندفرایندی Chrome، ممکن است یک برگه از فرایندهای مختلفی برای پردازش منبع و مقصد صفحه وب استفاده کند. بنابراین، اگر پیمایش در فرایند جدیدی انجام شود، ممکن است تا زمانی که پیمایش جدید نهایی شود (یعنی رویداد onCommitted برای قاب اصلی جدید ارسال شود)، رویدادها را هم از صفحه جدید و هم از صفحه قدیمی دریافت کنید. به عبارت دیگر، ممکن است بیش از یک توالی معلق از رویدادهای webNavigation با frameId یکسان وجود داشته باشد. توالی‌ها را می‌توان با کلید processId تشخیص داد.

همچنین توجه داشته باشید که درطول بارگذاری موقت، ممکن است فرایند چندین بار تغییر کند. این اتفاق زمانی می‌افتد که بار به سایت دیگری هدایت شود. در این حالت، رویدادهای تکراری onBeforeNavigate و onErrorOccurred را دریافت خواهید کرد تا زمانی که رویداد نهایی onCommitted را دریافت کنید.

مفهوم دیگری که در افزونه‌ها مشکل‌ساز است، چرخه حیات قاب است. یک قاب میزبان یک سند است (که با یک نشانی وب متعهد مرتبط است). سند می‌تواند تغییر کند (مثلاً با پیمایش) اما frameId تغییر نمی‌کند، بنابراین دشوار است که اتفاقی را که در سند خاصی افتاده است فقط با frameId مرتبط کرد. مفهوم documentId را معرفی می‌کنیم که شناسه یکتایی برای هر سند است. اگر قابی پیمایش شود و سند جدیدی را باز کند، شناسه تغییر خواهد کرد. این فیلد برای تعیین زمان تغییر وضعیت چرخه حیات صفحه‌ها (بین پیش‌پرداخت/فعال/ذخیره‌شده در حافظه پنهان) مفید است زیرا ثابت می‌ماند.

انواع گذار و واجدین شرایط

رویداد onCommitted در webNavigation API دارای ویژگی transitionType و transitionQualifiers است. نوع گذار همان است که در history API استفاده می‌شود و نحوه پیمایش مرورگر به این نشانی وب خاص را شرح می‌دهد. علاوه‌براین، چندین توصیف‌کننده انتقال می‌تواند برگردانده شود که ناوبری را بیشتر تعریف می‌کند.

توصیف‌کننده‌های انتقال زیر وجود دارد:

صعودکننده گذار	شرح
«client_redirect»	یک یا چند تغییر مسیر ناشی از جاوا اسکریپت یا برچسب‌های بازآوری متا در صفحه درطول پیمایش اتفاق افتاد.
«server_redirect»	یک یا چند تغییرمسیر ناشی از سرصفحه‌های HTTP ارسال‌شده از سرور درطول پیمایش اتفاق افتاد.
«forward_back»	کاربر از دکمه «جلو» یا «عقب» برای شروع پیمایش استفاده کرده است.
"from_address_bar"	کاربر پیمایش را از نوار نشانی (Omnibox) شروع کرده است.

مثال‌ها

برای امتحان کردن این API، نمونه webNavigation API را از مخزن chrome-extension-samples نصب کنید.

انواع

TransitionQualifier

Chrome نسخه ۴۴ به بالا

شمارشی

"client_redirect"

"server_redirect"

"forward_back"

"from_address_bar"

TransitionType

Chrome نسخه ۴۴ به بالا

علت ناوبری. از همان انواع انتقال تعریف‌شده در API سابقه استفاده می‌شود. این‌ها همان انواع انتقال تعریف‌شده در history API هستند، با این تفاوت که "start_page" به‌جای "auto_toplevel" قرار دارد (برای سازگاری با نسخه‌های قدیمی).

شمارشی

"link"

«تایپ‌شده»

"auto_bookmark"

"auto_subframe"

"manual_subframe"

«تولیدشده»

"start_page"

"form_submit"

"reload"

"keyword"

"keyword_generated"

روش‌ها

getAllFrames()

قول

chrome.webNavigation.getAllFrames(
  details: object,
  callback?: function,
): Promise<object[] | undefined>

اطلاعات مربوط به همه قاب‌های برگه داده‌شده را بازیابی می‌کند.

پارامترها

• جزئیات

  شیء

  اطلاعات مربوط به برگه‌ای که همه قاب‌ها از آن بازیابی می‌شود.

  • tabId

    شماره

    شناسه برگه.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (details?: object[]) => void

  • جزئیات

    object[] اختیاری

    فهرستی از قاب‌ها در برگه ارائه‌شده، اگر شناسه برگه مشخص‌شده نامعتبر باشد، مقدار null برگردانده می‌شود.

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • errorOccurred

      بولی

      اگر آخرین پیمایش در این قاب به‌دلیل خطا قطع شده باشد، یعنی رویداد onErrorOccurred فعال شده باشد، درست است.

    • frameId

      شماره

      شناسه قاب. مقدار ۰ نشان می‌دهد که این قاب اصلی است؛ مقدار مثبت نشان‌دهنده شناسه قاب فرعی است.

    • frameType

      FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • نشانی وب

      رشته

      نشانی وب که درحال‌حاضر با این قاب مرتبط است.

بازگشتی‌ها

• Promise<object[] | undefined>

  Chrome نسخه ۹۳ به بالا

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getFrame()

قول

chrome.webNavigation.getFrame(
  details: object,
  callback?: function,
): Promise<object | undefined>

اطلاعات مربوط به قاب داده‌شده را بازیابی می‌کند. قاب به <iframe> یا <frame> صفحه وب اشاره دارد و با شناسه برگه و شناسه قاب شناسایی می‌شود.

پارامترها

• جزئیات

  شیء

  اطلاعات مربوط به قابی که اطلاعات آن بازیابی می‌شود.

  • documentId

    رشته اختیاری

    Chrome نسخه ۱۰۶ و بالاتر

    شناسه منحصربه‌فرد جهانی سند. اگر frameId و/یا tabId ارائه شده باشد، برای مطابقت با سند یافت‌شده توسط شناسه سند ارائه‌شده اعتبارسنجی خواهد شد.

  • frameId

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

    شناسه قاب در برگه ارائه‌شده.

  • processId

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

    از Chrome 49 منسوخ شده است

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

    شناسه فرایندی که تولیدکننده تصویر را برای این برگه اجرا می‌کند.

  • tabId

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

    شناسه برگه‌ای که قاب در آن قرار دارد.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (details?: object) => void

  • جزئیات

    شیء اختیاری

    اطلاعات مربوط به قاب درخواست‌شده، اگر شناسه قاب و/یا شناسه برگه مشخص‌شده نامعتبر باشد، مقدار تهی است.

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • errorOccurred

      بولی

      اگر آخرین پیمایش در این قاب به‌دلیل خطا قطع شده باشد، یعنی رویداد onErrorOccurred فعال شده باشد، درست است.

    • frameType

      FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • نشانی وب

      رشته

      نشانی وبی که درحال‌حاضر با این قاب مرتبط است، اگر قاب شناسایی‌شده با frameId در نقطه‌ای از برگه داده‌شده وجود داشته باشد. این واقعیت که یک نشانی وب با یک frameId مشخص مرتبط است، به این معنی نیست که قاب مربوطه هنوز وجود دارد.

بازگشتی‌ها

• Promise<object | undefined>

  Chrome نسخه ۹۳ به بالا

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onBeforeNavigate

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

وقتی ناوبری درحال وقوع باشد، فعال می‌شود.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب برای برگه و فرایند داده‌شده یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      از Chrome 50 منسوخ شده است

      ‫processId دیگر برای این رویداد تنظیم نمی‌شود، زیرا فرایندی که سند حاصل را ارائه می‌کند تا زمان onCommit مشخص نیست.

      مقدار -۱.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن درحال رخ دادن است.

    • timeStamp

      شماره

      زمانی که مرورگر در آستانه شروع ناوبری بود، برحسب میلی‌ثانیه از مبدأ زمانی.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onCommitted

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

وقتی ناوبری انجام می‌شود، فعال می‌شود. ممکن است سند (و منابعی که به آن‌ها ارجاع می‌دهد، مانند تصاویر و زیرقاب‌ها) همچنان درحال بارگیری باشد، اما حداقل بخشی از سند از سرور دریافت شده است و مرورگر تصمیم گرفته است به سند جدید برود.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمانی که ناوبری انجام شده است، برحسب میلی‌ثانیه از تاریخ.

    • transitionQualifiers

      TransitionQualifier[]

      فهرستی از واجدین شرایط انتقال.

    • transitionType

      TransitionType

      علت ناوبری.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onCompleted

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمان پایان بارگیری سند، برحسب میلی‌ثانیه از تاریخ.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onCreatedNavigationTarget

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

وقتی پنجره جدیدی، یا برگه جدیدی در پنجره موجود، برای میزبانی پیمایش ایجاد می‌شود، فعال می‌شود.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • sourceFrameId

      شماره

      شناسه قاب با sourceTabId که پیمایش در آن راه‌اندازی شده است. ‫0 نشان‌دهنده قاب اصلی است.

    • sourceProcessId

      شماره

      شناسه فرایندی که ارائه‌دهنده تصویر را برای قاب منبع اجرا می‌کند.

    • sourceTabId

      شماره

      شناسه زبانه‌ای که پیمایش در آن راه‌اندازی شده است.

    • tabId

      شماره

      شناسه برگه‌ای که نشانی وب در آن باز شده است

    • timeStamp

      شماره

      زمانی که مرورگر درحال ایجاد نمای جدیدی بود، برحسب میلی‌ثانیه از تاریخ مبدأ.

    • نشانی وب

      رشته

      نشانی وبی که باید در پنجره جدید باز شود.

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onDOMContentLoaded

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

وقتی DOM صفحه کاملاً ساخته شده باشد، اما منابع ارجاع‌شده ممکن است بارگیری را تکمیل نکرده باشند، فعال می‌شود.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمانی که DOM صفحه کاملاً ساخته شده است، برحسب میلی‌ثانیه از تاریخ.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onErrorOccurred

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

وقتی خطایی رخ می‌دهد و پیمایش لغو می‌شود، فعال می‌شود. این اتفاق ممکن است به‌دلیل بروز خطای شبکه یا لغو پیمایش توسط کاربر رخ دهد.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • خطا

      رشته

      توضیح خطا.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      از Chrome 50 منسوخ شده است

      ‫processId دیگر برای این رویداد تنظیم نشده است.

      مقدار -۱.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمان وقوع خطا، برحسب میلی‌ثانیه از مبدأ تاریخ.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onHistoryStateUpdated

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمانی که ناوبری انجام شده است، برحسب میلی‌ثانیه از تاریخ.

    • transitionQualifiers

      TransitionQualifier[]

      فهرستی از واجدین شرایط انتقال.

    • transitionType

      TransitionType

      علت ناوبری.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onReferenceFragmentUpdated

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • documentId

      رشته

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند بارشده.

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      Chrome نسخه ۱۰۶ و بالاتر

      چرخه حیاتی که سند در آن قرار دارد.

    • frameId

      شماره

      مقدار ۰ نشان می‌دهد که پیمایش در پنجره محتوای برگه اتفاق می‌افتد؛ مقدار مثبت نشان‌دهنده پیمایش در زیرقاب است. شناسه‌های قاب در هر برگه یکتا هستند.

    • frameType

      extensionTypes.FrameType

      Chrome نسخه ۱۰۶ و بالاتر

      نوع قابی که پیمایش در آن انجام شده است.

    • parentDocumentId

      رشته اختیاری

      Chrome نسخه ۱۰۶ و بالاتر

      شناسه UUID سند اصلی که مالک این قاب است. اگر والدی وجود نداشته باشد، این تنظیم نمی‌شود.

    • parentFrameId

      شماره

      Chrome نسخه ۷۴ و بالاتر

      شناسه قاب اصلی، یا -1 اگر این قاب اصلی باشد.

    • processId

      شماره

      شناسه فرایندی که پردازنده را برای این قاب اجرا می‌کند.

    • tabId

      شماره

      شناسه برگه‌ای که پیمایش در آن رخ می‌دهد.

    • timeStamp

      شماره

      زمانی که ناوبری انجام شده است، برحسب میلی‌ثانیه از تاریخ.

    • transitionQualifiers

      TransitionQualifier[]

      فهرستی از واجدین شرایط انتقال.

    • transitionType

      TransitionType

      علت ناوبری.

    • نشانی وب

      رشته

• فیلترها

  شیء اختیاری

  • نشانی وب

    events.UrlFilter[]

    شرایطی که نشانی وب پیمایش‌شده باید داشته باشد.

onTabReplaced

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (details: object) => void

  • جزئیات

    شیء

    • replacedTabId

      شماره

      شناسه برگه‌ای که جایگزین شده است.

    • tabId

      شماره

      شناسه برگه‌ای که جایگزین برگه قدیمی شده است.

    • timeStamp

      شماره

      زمان وقوع جایگزینی، برحسب میلی‌ثانیه از تاریخ.