chrome.webviewTag

شرح

از برچسب webview برای بار کردن فعالانه محتوای زنده از وب در شبکه و جاسازی آن در «برنامه Chrome» استفاده کنید. برنامه شما می‌تواند ظاهر webview را کنترل کند و با محتوای وب تعامل داشته باشد، پیمایش‌ها را در صفحه وب جاسازی‌شده آغاز کند، به رویدادهای خطایی که در آن اتفاق می‌افتد واکنش نشان دهد، و غیره (استفاده را ببینید).

اجازه‌ها

webview

دردسترس بودن

فقط ChromeOS

انواع

ClearDataOptions

گزینه‌هایی که تعیین می‌کنند چه داده‌هایی باید توسط clearData پاک شود.

مشخصات

  • از

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

    داده‌های جمع‌آوری‌شده در این تاریخ یا پس‌از آن را پاک می‌کند، که برحسب میلی‌ثانیه از تاریخ مبدأ نشان داده می‌شود (ازطریق روش getTime شیء Date جاوا اسکریپت قابل‌دسترسی است). اگر وجود نداشته باشد، به‌طور پیش‌فرض روی 0 تنظیم می‌شود (که همه داده‌های مرور را برمی‌دارد).

ClearDataTypeSet

مجموعه‌ای از انواع داده. خصوصیت‌های واردنشده به‌عنوان false تفسیر می‌شوند.

مشخصات

  • حافظه نهان برنامه

    بولی اختیاری

    حافظه پنهان برنامه وب‌سایت‌ها.

  • حفظ کردن

    بولی اختیاری

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

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

  • کوکی‌ها

    بولی اختیاری

    کوکی‌های پارتیشن.

  • fileSystems

    بولی اختیاری

    سیستم‌های فایل وب‌سایت‌ها.

  • indexedDB

    بولی اختیاری

    داده‌های IndexedDB وب‌سایت‌ها.

  • localStorage

    بولی اختیاری

    داده‌های فضای ذخیره‌سازی محلی وب‌سایت‌ها.

  • persistentCookies

    بولی اختیاری

    Chrome نسخه ۵۸ به بالا

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

  • sessionCookies

    بولی اختیاری

    Chrome نسخه ۵۸ به بالا

    کوکی‌های جلسه پارتیشن.

  • webSQL

    بولی اختیاری

    داده‌های WebSQL وب‌سایت‌ها.

ContentScriptDetails

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

جزئیات متن محتوا برای تزریق. برای جزئیات بیشتر، به اسناد دستورگان‌های محتوا مراجعه کنید.

مشخصات

  • all_frames

    بولی اختیاری

    اگر all_frames برابر با true باشد، به این معنی است که جاوا اسکریپت یا CSS باید به همه قاب‌های صفحه فعلی تزریق شود. به‌طور پیش‌فرض، all_frames برابر با false است و جاوا اسکریپت یا CSS فقط به قاب بالایی تزریق می‌شود.

  • css

    InjectionItems اختیاری

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

  • exclude_globs

    رشته[] اختیاری

    پس‌از مطابقت‌ها اعمال می‌شود تا نشانی‌های وب مطابق با این glob مستثنی شوند. برای شبیه‌سازی کلیدواژه @exclude Greasemonkey درنظر گرفته شده است.

  • exclude_matches

    رشته[] اختیاری

    صفحه‌هایی را که این متن محتوا در آن‌ها تزریق می‌شود مستثنی می‌کند.

  • include_globs

    رشته[] اختیاری

    پس‌از مطابقت‌ها اعمال می‌شود تا فقط نشانی‌های وبی را که با این glob مطابقت دارند دربرگیرد. برای شبیه‌سازی کلیدواژه @include Greasemonkey درنظر گرفته شده است.

  • js

    InjectionItems اختیاری

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

  • match_about_blank

    بولی اختیاری

    اینکه آیا دستورگان محتوا در about:blank و about:srcdoc درج شود یا نه. اسکریپت‌های محتوا فقط زمانی به صفحه‌ها تزریق می‌شوند که نشانی وب موروثی آن‌ها با یکی از الگوهای اعلام‌شده در فیلد مطابقت‌ها مطابقت داشته باشد. نشانی وب ارث‌بری نشانی وب سندی است که قاب یا پنجره را ایجاد کرده است. متن‌های محتوا را نمی‌توان در قاب‌های جعبه امن درج کرد.

  • انطباق‌ها

    string[]

    مشخص می‌کند این متن محتوا به کدام صفحه‌ها تزریق خواهد شد.

  • نام

    رشته

    نام متن محتوا برای تزریق.

  • run_at

    RunAt اختیاری

    زودترین زمانی که جاوا اسکریپت یا CSS به برگه تزریق خواهد شد. به‌طور پیش‌فرض روی «document_idle» تنظیم شده است.

ContentWindow

ارسال پیام به پنجره مهمان.

مشخصات

  • postMessage

    باطل کردن

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

    مهمان می‌تواند با پست کردن پیام به event.source در رویداد پیامی که دریافت می‌کند، به جاسازنده پاسخ دهد.

    این میانای برنامه‌سازی کاربردی با میانای برنامه‌سازی کاربردی HTML5 postMessage برای ارتباط بین صفحه‌های وب یکسان است. جاسازکننده می‌تواند با افزودن شنونده رویداد message به قاب خودش، به پاسخ‌ها گوش دهد.

    تابع postMessage به‌صورت زیر است:

    (message: any, targetOrigin: string) => {...}

    • پیام

      همه

      شیء پیام برای ارسال به مهمان.

    • targetOrigin

      رشته

      مشخص می‌کند که مبدأ پنجره مهمان برای ارسال رویداد چه باید باشد.

ContextMenuCreateProperties

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

مشخصات

  • دارای علامت

    بولی اختیاری

    وضعیت اولیه چارگوش انتخاب یا مورد رادیویی: درست برای انتخاب‌شده و نادرست برای انتخاب‌نشده. در هر گروه از گزینه‌های رادیویی، فقط یک گزینه رادیویی را می‌توان در هر زمان انتخاب کرد.

  • بافت‌ها

    [ContextType, ...ContextType[]] اختیاری

    فهرست زمینه‌هایی که این گزینه منو در آن‌ها نشان داده خواهد شد. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی ['page'] تنظیم می‌شود.

  • documentUrlPatterns

    رشته[] اختیاری

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

  • فعال شد

    بولی اختیاری

    اینکه این مورد منوِ بافت فعال است یا غیرفعال. پیش‌فرض‌ها به true.

  • id

    رشته اختیاری

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

  • parentId

    رشته | عدد اختیاری

    شناسه گزینه منوِ والد؛ این شناسه گزینه را به فرزند گزینه اضافه‌شده قبلی تبدیل می‌کند.

  • targetUrlPatterns

    رشته[] اختیاری

    مشابه documentUrlPatterns، اما به شما امکان می‌دهد براساس ویژگی src برچسب‌های img/audio/video و href برچسب‌های anchor فیلتر کنید.

  • عنوان

    رشته اختیاری

    نوشتاری که باید در مورد نمایش داده شود؛ این مورد الزامی است مگراینکه type «جداکننده» باشد. وقتی بافت «انتخاب» است، می‌توانید از %s در رشته استفاده کنید تا نوشتار انتخاب‌شده را نشان دهید. برای مثال، اگر مقدار این پارامتر «ترجمه کردن ‘%s’ به زبان ساختگی Pig Latin» باشد و کاربر کلمه «cool» را انتخاب کند، گزینه منوِ بافت برای انتخاب «ترجمه کردن ‘cool’ به زبان ساختگی Pig Latin» است.

  • نوع

    ItemType اختیاری

    نوع گزینه منو. اگر مشخص نشده باشد، به‌طور پیش‌فرض روی «عادی» تنظیم می‌شود.

  • onclick

    void اختیاری

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

    تابع onclick به‌صورت زیر است:

    (info: OnClickData) => {...}

    • اطلاعات

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

ContextMenus

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

مشخصات

  • onShow

    Event<functionvoidvoid>

    قبل‌از نمایش منوِ زمینه‌ای در این webview فعال شد. می‌تواند برای غیرفعال کردن این منوِ بافت با فراخوانی event.preventDefault() استفاده شود.

    تابع onShow.addListener به‌صورت زیر است:

    (callback: function) => {...}

    • تماس برگشتی

      عملکرد

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

      (event: object) => void

      • رویداد

        شیء

        • preventDefault

          باطل کردن

          برای جلوگیری از نمایش منوِ بافت، این را فراخوانی کنید.

          تابع preventDefault به‌صورت زیر است:

          () => {...}

  • ایجاد

    باطل کردن

    مورد منوِ زمینه‌ای جدیدی ایجاد می‌کند. توجه داشته باشید که اگر خطایی درطول ایجاد رخ دهد، ممکن است تا زمانی که فراخوانی برگشتی ایجاد فعال نشود متوجه آن نشوید (جزئیات در runtime.lastError خواهد بود).

    تابع create به‌صورت زیر است:

    (createProperties: object, callback?: function) => {...}

    • createProperties

      شیء

      مشخصه‌های استفاده‌شده برای ایجاد مورد

    • تماس برگشتی

      تابع اختیاری

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

      () => void

    • returns

      رشته | عدد

      شناسه مورد جدیداً ایجادشده.

  • برداشتن

    باطل کردن

    موردی را از منوِ زمینه‌ای برمی‌دارد.

    تابع remove به‌صورت زیر است:

    (menuItemId: string | number, callback?: function) => {...}

    • menuItemId

      رشته | عدد

      شناسه مورد منوِ بافت برای برداشتن.

    • تماس برگشتی

      تابع اختیاری

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

      () => void

  • removeAll

    باطل کردن

    همه موارد منوِ بافت اضافه‌شده به این webview را برمی‌دارد.

    تابع removeAll به‌صورت زیر است:

    (callback?: function) => {...}

    • تماس برگشتی

      تابع اختیاری

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

      () => void

  • به‌روز کردن

    باطل کردن

    مورد منوِ زمینه‌ای را که قبلاً ایجاد شده است به‌روز می‌کند.

    تابع update به‌صورت زیر است:

    (id: string | number, updateProperties: object, callback?: function) => {...}

    • id

      رشته | عدد

      شناسه موردی که باید به‌روز شود.

    • updateProperties

      شیء

      ویژگی‌هایی که باید به‌روز شود. همان مقادیر تابع create را می‌پذیرد.

    • تماس برگشتی

      تابع اختیاری

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

      () => void

ContextMenuUpdateProperties

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

مشخصات

  • دارای علامت

    بولی اختیاری

    وضعیت چارگوش انتخاب یا مورد رادیویی: true برای انتخاب‌شده و false برای انتخاب‌نشده. در هر گروه از گزینه‌های رادیویی، فقط یک گزینه رادیویی را می‌توان در هر زمان انتخاب کرد.

  • بافت‌ها

    [ContextType, ...ContextType[]] اختیاری

    فهرست زمینه‌هایی که این گزینه منو در آن‌ها نشان داده خواهد شد.

  • documentUrlPatterns

    رشته[] اختیاری

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

  • فعال شد

    بولی اختیاری

    اینکه این مورد منوِ بافت فعال است یا غیرفعال.

  • parentId

    رشته | عدد اختیاری

    شناسه گزینه منوِ والد؛ این شناسه گزینه را به فرزند گزینه اضافه‌شده قبلی تبدیل می‌کند. توجه: نمی‌توانید موردی را به فرزند یکی از نوادگان خودش تغییر دهید.

  • targetUrlPatterns

    رشته[] اختیاری

    مشابه documentUrlPatterns، اما به شما امکان می‌دهد براساس ویژگی src برچسب‌های img/audio/video و href برچسب‌های anchor فیلتر کنید.

  • عنوان

    رشته اختیاری

    نوشتاری که باید در مورد نمایش داده شود

  • نوع

    ItemType اختیاری

    نوع گزینه منو.

  • onclick

    void اختیاری

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

    تابع onclick به‌صورت زیر است:

    (info: OnClickData) => {...}

    • اطلاعات

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

ContextType

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

بافت‌های مختلفی که منو می‌تواند در آن‌ها ظاهر شود. مشخص کردن «همه» معادل ترکیب همه زمینه‌های دیگر است.

شمارشی

«همه»

«صفحه»

"frame"

«انتخاب»

"link"

«editable»

"image"

"video"

"audio"

DialogController

میانای پیوست‌شده به رویدادهای dialog DOM.

مشخصات

  • لغو کردن

    باطل کردن

    کادر گفتگو را رد کنید. معادل کلیک کردن روی «لغو» در کادر گفتگوی confirm یا prompt.

    تابع cancel به‌صورت زیر است:

    () => {...}

  • باشه

    باطل کردن

    کادر گفتگو را بپذیرید. معادل کلیک کردن روی «تأیید» در کادر گفتگوی alert،‏ confirm، یا prompt.

    تابع ok به‌صورت زیر است:

    (response?: string) => {...}

    • پاسخ

      رشته اختیاری

      رشته پاسخ برای ارائه به مهمان هنگام پذیرش کادر گفتگوی prompt.

DialogMessageType

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

نوع کادر گفتگوی مدال درخواست‌شده توسط مهمان.

شمارشی

«هشدار»

«تأیید»

«پیام‌واره»

DownloadPermissionRequest

نوع شیء request که با رویداد DOM download permissionrequest همراه است.

مشخصات

  • requestMethod

    رشته

    نوع درخواست اچ‌تی‌تی‌پی (مثلاً GET) مرتبط با درخواست بارگیری.

  • نشانی وب

    رشته

    نشانی وب بارگیری درخواست‌شده.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید. اگر allow فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع deny به‌صورت زیر است:

    () => {...}

ExitReason

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

رشته‌ای که دلیل خروج را نشان می‌دهد.

شمارشی

«عادی»

«غیرعادی»

«خراب شد»

«کشته‌شده»

"oom killed"

«oom»

«راه‌اندازی نشد»

«integrity failure»

FileSystemPermissionRequest

نوع شیء request که با رویداد DOM filesystem permissionrequest همراه است.

مشخصات

  • نشانی وب

    رشته

    نشانی وب قابی که درخواست دسترسی به سیستم فایل محلی را دارد.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید.

    تابع deny به‌صورت زیر است:

    () => {...}

FindCallbackResults

شامل همه نتایج درخواست یافتن است.

مشخصات

  • activeMatchOrdinal

    شماره

    عدد ترتیبی مطابقت فعلی.

  • لغو شد

    بولی

    نشان می‌دهد که آیا این درخواست جستجو لغو شده است یا نه.

  • numberOfMatches

    شماره

    تعداد دفعاتی که searchText در صفحه مطابقت داده شد.

  • selectionRect

    مستطیلی را در اطراف مطابقت فعال در مختصات صفحه توصیف می‌کند.

FindOptions

گزینه‌های درخواست یافتن.

مشخصات

  • عقب

    بولی اختیاری

    پرچم برای یافتن موارد منطبق به‌ترتیب معکوس. مقدار پیش‌فرض false است.

  • matchCase

    بولی اختیاری

    پرچم‌گذاری برای مطابقت با حساسیت به حروف بزرگ و کوچک. مقدار پیش‌فرض false است.

FullscreenPermissionRequest

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

نوع شیء request که با رویداد DOM fullscreen permissionrequest همراه است.

مشخصات

  • منشأ

    رشته

    مبدأ قاب داخل webview که درخواست تمام‌صفحه را آغاز کرده است.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید.

    تابع deny به‌صورت زیر است:

    () => {...}

GeolocationPermissionRequest

نوع شیء request که با رویداد DOM geolocation permissionrequest همراه است.

مشخصات

  • نشانی وب

    رشته

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

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید. اگر allow فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع deny به‌صورت زیر است:

    () => {...}

HidPermissionRequest

Chrome نسخه ۱۲۵ و بالاتر

نوع شیء request که با رویداد DOM permissionrequest hid همراه است.

مشخصات

  • نشانی وب

    رشته

    نشانی وب قابی که درخواست دسترسی به HID API را دارد.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید. اگر allow فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع deny به‌صورت زیر است:

    () => {...}

InjectDetails

جزئیات اسکریپت یا CSS برای تزریق. یا کد یا ویژگی فایل باید تنظیم شود، اما هر دو ممکن است به‌طور هم‌زمان تنظیم نشوند.

مشخصات

  • کد

    رشته اختیاری

    کد جاوا اسکریپت یا CSS برای تزریق.

    هشدار: هنگام استفاده از پارامتر code مراقب باشید. استفاده نادرست از آن ممکن است برنامه‌تان را درمعرض حملات دستورگان‌نویسی بین‌سایتی قرار دهد.

  • فایل

    رشته اختیاری

    فایل CSS یا جاوا اسکریپت برای تزریق.

InjectionItems

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

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

مشخصات

  • کد

    رشته اختیاری

    کد جاوا اسکریپت یا CSS برای تزریق به صفحه‌های منطبق.

  • فایل‌ها

    رشته[] اختیاری

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

LoadAbortReason

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

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

شمارشی

"ERR_ABORTED"

«ERR_INVALID_URL»

"ERR_DISALLOWED_URL_SCHEME"

"ERR_BLOCKED_BY_CLIENT"

«ERR_ADDRESS_UNREACHABLE»

«ERR_EMPTY_RESPONSE»

"ERR_FILE_NOT_FOUND"

"ERR_UNKNOWN_URL_SCHEME"

LoadPluginPermissionRequest

نوع شیء request که با رویداد DOM loadplugin permissionrequest همراه است.

مشخصات

  • identifier

    رشته

    رشته شناسه افزونه.

  • نام

    رشته

    نام نمایشی افزونه.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید. اگر deny فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید.

    تابع deny به‌صورت زیر است:

    () => {...}

MediaPermissionRequest

نوع شیء request که با رویداد DOM media permissionrequest همراه است.

مشخصات

  • نشانی وب

    رشته

    نشانی وب قابی که دسترسی به رسانه کاربر را درخواست می‌کند.

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید. اگر allow فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع deny به‌صورت زیر است:

    () => {...}

NewWindow

میانای پیوست‌شده به رویدادهای newwindow DOM.

مشخصات

  • پیوست کردن

    باطل کردن

    صفحه هدف درخواست‌شده را به عنصر webview موجود پیوست کنید.

    تابع attach به‌صورت زیر است:

    (webview: object) => {...}

    • webview

      شیء

      عنصر webview که صفحه هدف باید به آن پیوست شود.

  • صرف‌نظر کردن

    باطل کردن

    درخواست پنجره جدید را لغو کنید.

    تابع discard به‌صورت زیر است:

    () => {...}

PermissionType

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

نوع اجازه‌ای که درخواست می‌شود.

شمارشی

«رسانه»

«مکان‌یابی جغرافیایی»

"pointerLock"

«بارگیری»

"loadplugin"

«filesystem»

«تمام‌صفحه»

«hid»

PointerLockPermissionRequest

نوع شیء request که با رویداد DOM pointerLock permissionrequest همراه است.

مشخصات

  • lastUnlockedBySelf

    بولی

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

  • نشانی وب

    رشته

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

  • userGesture

    بولی

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

  • مجاز کردن

    باطل کردن

    درخواست اجازه را بپذیرید.

    تابع allow به‌صورت زیر است:

    () => {...}

  • رد کردن

    باطل کردن

    درخواست اجازه را رد کنید. اگر allow فراخوانی نشود، این رفتار پیش‌فرض است.

    تابع deny به‌صورت زیر است:

    () => {...}

SelectionRect

مستطیلی را در مختصات صفحه توصیف می‌کند.

معناشناسی دربرگیری شبیه آرایه است؛ یعنی مختصات (left, top) دربرگرفته‌شده توسط مستطیل درنظر گرفته می‌شود، اما مختصات (left + width, top) این‌طور نیست.

مشخصات

  • ارتفاع

    شماره

    ارتفاع مستطیل.

  • چپ

    شماره

    فاصله از لبه چپ صفحه تا لبه چپ مستطیل.

  • بالا

    شماره

    فاصله از لبه بالایی صفحه تا لبه بالایی مستطیل.

  • عرض

    شماره

    عرض مستطیل.

StopFindingAction

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

تعیین می‌کند که پس‌از پایان جلسه جستجو، با مطابقت فعال چه کاری انجام شود. clear برجسته‌سازی را از روی مطابقت فعال پاک می‌کند؛ keep مطابقت فعال را برجسته نگه می‌دارد؛ activate مطابقت فعال را برجسته نگه می‌دارد و کلیک کاربر روی آن مطابقت را شبیه‌سازی می‌کند. کنش پیش‌فرض keep است.

شمارشی

«clear»

«keep»

«فعال کردن»

WebRequestEventInterface

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

میانایی که دسترسی به رویدادهای webRequest را در صفحه مهمان فراهم می‌کند. برای جزئیات مربوط به چرخه عمر webRequest و مفاهیم مرتبط، به میانای برنامه‌سازی کاربردی افزونه‌های chrome.webRequest مراجعه کنید. توجه: رویداد chrome.webRequest.onActionIgnored برای webviews پشتیبانی نمی‌شود.

برای نشان دادن تفاوت استفاده از میانای برنامه‌سازی کاربردی webRequest افزونه‌ها، کد نمونه زیر را درنظر بگیرید که هرگونه درخواست مهمان برای نشانی‌های وب منطبق با *://www.evil.com/* را مسدود می‌کند:

webview.request.onBeforeRequest.addListener(
  function(details) { return {cancel: true}; },
  {urls: ["*://www.evil.com/*"]},
  ["blocking"]);

علاوه‌براین، این میانجی از قوانین webRequest اعلانی ازطریق رویدادهای onRequest و onMessage پشتیبانی می‌کند. برای جزئیات میانای برنامه‌سازی کاربردی، به declarativeWebRequest مراجعه کنید.

توجه داشته باشید که شرایط و کنش‌های webRequests وب‌نمای اعلانی باید از همتایان chrome.webViewRequest.* خود نمونه‌سازی شوند. کد نمونه زیر به‌صورت اعلانی همه درخواست‌ها به "example.com" را در نمای وب myWebview مسدود می‌کند:

var rule = {
  conditions: [
    new chrome.webViewRequest.RequestMatcher({ url: { hostSuffix: 'example.com' } })
  ],
  actions: [ new chrome.webViewRequest.CancelRequest() ]
};
myWebview.request.onRequest.addRules([rule]);

WindowOpenDisposition

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

وضعیت درخواستی پنجره جدید.

شمارشی

«نادیده گرفتن»

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

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

نحوه مدیریت بزرگ‌نمایی را در webview تعریف می‌کند.

شمارشی

«per-origin»
تغییرات بزرگ‌نمایی در مبدأ صفحه بزرگ‌نمایی‌شده باقی می‌ماند، یعنی همه نماهای وب دیگر در همان پارتیشن که به همان مبدأ پیمایش می‌شوند نیز بزرگ‌نمایی خواهند شد. علاوه‌براین، per-origin تغییرات بزرگ‌نمایی با مبدأ ذخیره می‌شود، یعنی هنگام پیمایش به صفحه‌های دیگر در همان مبدأ، همه آن‌ها با همان ضریب بزرگ‌نمایی بزرگ‌نمایی خواهند شد.

«per-view»
تغییرات بزرگ‌نمایی فقط در این وب‌نما اعمال می‌شود و تغییرات بزرگ‌نمایی در وب‌نماهای دیگر بر بزرگ‌نمایی این وب‌نما تأثیر نمی‌گذارد. همچنین، تغییرات بزرگ‌نمایی per-view در پیمایش بازنشانی می‌شود؛ پیمایش نمای وب همیشه صفحه‌ها را با ضریب بزرگ‌نمایی هر مبدأ (در محدوده پارتیشن) بار می‌کند.

«disabled»
همه بزرگ‌نمایی‌ها را در نمای وب غیرفعال می‌کند. محتوا به سطح بزرگ‌نمایی پیش‌فرض برمی‌گردد و همه تغییرات بزرگ‌نمایی که انجام شده است نادیده گرفته می‌شود.

مشخصات

contentWindow

مرجع شیء که می‌تواند برای پست کردن پیام در صفحه مهمان استفاده شود.

نوع

contextMenus

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

شبیه به میانای برنامه‌سازی کاربردی ContextMenus در Chrome، اما به‌جای مرورگر برای webview اعمال می‌شود. از webview.contextMenus API برای افزودن موارد به منوِ بافت webview استفاده کنید. می‌توانید انتخاب کنید که موارد اضافه‌شده به منوی بافت برای چه نوع اشیایی اعمال شود، مثلاً تصاویر، اَبَرپیوندها، و صفحه‌ها.

نوع

request

میانایی که دسترسی به رویدادهای webRequest را در صفحه مهمان فراهم می‌کند.

روش‌ها

addContentScripts()

Chrome نسخه ۴۴ به بالا
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)
: void

قوانین تزریق متن محتوا را به webview اضافه می‌کند. وقتی webview به صفحه‌ای می‌رود که با یک یا چند قانون مطابقت دارد، متن‌های مرتبط تزریق خواهند شد. می‌توانید با برنامه‌های رایانه‌ای قانون اضافه کنید یا قانون‌های موجود را به‌روز کنید.

مثال زیر دو قانون به webview اضافه می‌کند: «myRule» و «anotherRule».

webview.addContentScripts([
  {
    name: 'myRule',
    matches: ['http://www.foo.com/*'],
    css: { files: ['mystyles.css'] },
    js: { files: ['jquery.js', 'myscript.js'] },
    run_at: 'document_start'
  },
  {
    name: 'anotherRule',
    matches: ['http://www.bar.com/*'],
    js: { code: "document.body.style.backgroundColor = 'red';" },
    run_at: 'document_end'
  }]);
 ...

// Navigates webview.
webview.src = 'http://www.foo.com';

می‌توانید تماس addContentScripts را تا زمانی که نیاز به تزریق اسکریپت‌ها دارید به‌تعویق بیندازید.

مثال زیر نشان می‌دهد که چگونه یک قانون موجود را بازنویسی کنید.

webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.foo.com/*'],
    js: { files: ['scriptA.js'] },
    run_at: 'document_start'}]);

// Do something.
webview.src = 'http://www.foo.com/*';
 ...
// Overwrite 'rule' defined before.
webview.addContentScripts([{
    name: 'rule',
    matches: ['http://www.bar.com/*'],
    js: { files: ['scriptB.js'] },
    run_at: 'document_end'}]);

اگر webview به مبدأ (مثلاً foo.com) پیمایش شده باشد و webview.addContentScripts را برای افزودن «myRule» فراخوانی کند، باید منتظر پیمایش بعدی باشید تا اسکریپت‌ها تزریق شوند. اگر تزریق فوری می‌خواهید، executeScript کار درست را انجام خواهد داد.

قوانین حتی درصورت ازکار افتادن یا متوقف شدن فرایند مهمان یا حتی درصورت تغییر والد webview حفظ می‌شوند.

برای جزئیات بیشتر، به اسناد دستورگان‌های محتوا مراجعه کنید.

پارامترها

back()

chrome.webviewTag.back(
  callback?: function,
)
: void

درصورت امکان، یک ورودی سابقه به عقب پیمایش می‌کند. معادل go(-1).

پارامترها

  • تماس برگشتی

    تابع اختیاری

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

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

    (success: boolean) => void

    • موفقیت‌آمیز

      بولی

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

canGoBack()

chrome.webviewTag.canGoBack(): boolean

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

بازگشتی‌ها

  • بولی

canGoForward()

chrome.webviewTag.canGoForward(): boolean

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

بازگشتی‌ها

  • بولی

captureVisibleRegion()

Chrome نسخه ۵۰ و بالاتر
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)
: void

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

پارامترها

  • گزینه‌ها

    ImageDetails اختیاری

  • تماس برگشتی

    عملکرد

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

    (dataUrl: string) => void

    • dataUrl

      رشته

      نشانی وب داده‌ای که تصویری از ناحیه قابل‌مشاهده برگه ضبط‌شده را کدگذاری می‌کند. ممکن است به ویژگی «src» عنصر تصویر HTML برای نمایش اختصاص داده شود.

clearData()

chrome.webviewTag.clearData(
  options: ClearDataOptions,
  types: ClearDataTypeSet,
  callback?: function,
)
: void

داده‌های مرور را برای بخش webview پاک می‌کند.

پارامترها

  • گزینه‌ها

    گزینه‌هایی که تعیین می‌کنند کدام داده‌ها پاک شوند.

  • انواع

    انواع داده‌هایی که باید پاک شود.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

executeScript()

chrome.webviewTag.executeScript(
  details: InjectDetails,
  callback?: function,
)
: void

کد جاوا اسکریپت را به صفحه مهمان تزریق می‌کند.

کد نمونه زیر از تزریق دستورگان برای تنظیم رنگ پس‌زمینه صفحه مهمان روی قرمز استفاده می‌کند:

webview.executeScript({ code: "document.body.style.backgroundColor = 'red'" });

پارامترها

  • جزئیات

    جزئیات اسکریپت برای اجرا.

  • تماس برگشتی

    تابع اختیاری

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

    (result?: any[]) => void

    • نتیجه

      any[] اختیاری

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

find()

chrome.webviewTag.find(
  searchText: string,
  options?: FindOptions,
  callback?: function,
)
: void

درخواست «یافتن در صفحه» را آغاز می‌کند.

پارامترها

  • searchText

    رشته

    رشته‌ای که باید در صفحه پیدا شود.

  • گزینه‌ها

    FindOptions اختیاری

    گزینه‌های درخواست یافتن.

  • تماس برگشتی

    تابع اختیاری

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

    (results?: FindCallbackResults) => void

    • نتایج

      FindCallbackResults اختیاری

      شامل همه نتایج درخواست یافتن است. اگر از results در بدنه تابع بازخوانی استفاده نشود، می‌توان آن را حذف کرد؛ برای مثال، اگر از بازخوانی فقط برای تشخیص زمان تکمیل درخواست جستجو استفاده شود.

forward()

chrome.webviewTag.forward(
  callback?: function,
)
: void

درصورت امکان، یک ورودی سابقه به جلو پیمایش می‌کند. معادل go(1).

پارامترها

  • تماس برگشتی

    تابع اختیاری

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

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

    (success: boolean) => void

    • موفقیت‌آمیز

      بولی

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

getAudioState()

Chrome نسخه ۶۲ به بالا
chrome.webviewTag.getAudioState(
  callback: function,
)
: void

وضعیت صوت را پُرسمان می‌کند.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (audible: boolean) => void

    • audible

      بولی

getProcessId()

chrome.webviewTag.getProcessId(): number

شناسه پردازش داخلی Chrome را برای پردازش فعلی صفحه وب مهمان برمی‌گرداند، که به جاسازها اجازه می‌دهد بدانند با خاتمه دادن به پردازش، چند مهمان تحت تأثیر قرار می‌گیرند. دو مهمان فقط درصورتی فرایندی را هم‌رسانی می‌کنند که به یک برنامه تعلق داشته باشند و شناسه پارتیشن فضای ذخیره‌سازی یکسانی داشته باشند. این فراخوانی همگام است و مفهوم ذخیره‌شده جاساز از شناسه پردازش فعلی را برمی‌گرداند. شناسه پردازش با شناسه پردازش سیستم‌عامل یکسان نیست.

بازگشتی‌ها

  • شماره

getUserAgent()

chrome.webviewTag.getUserAgent(): string

رشته نماینده کاربر را که webview برای درخواست‌های صفحه مهمان استفاده می‌کند برمی‌گرداند.

بازگشتی‌ها

  • رشته

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)
: void

ضریب بزرگ‌نمایی فعلی را دریافت می‌کند.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (zoomFactor: number) => void

    • zoomFactor

      شماره

      ضریب بزرگ‌نمایی کنونی.

getZoomMode()

Chrome نسخه ۴۳ و بالاتر
chrome.webviewTag.getZoomMode(
  callback: function,
)
: void

حالت بزرگ‌نمایی فعلی را دریافت می‌کند.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      حالت بزرگ‌نمایی کنونی webview.

go()

chrome.webviewTag.go(
  relativeIndex: number,
  callback?: function,
)
: void

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

پارامترها

  • relativeIndex

    شماره

    شاخص سابقه نسبی که webview باید به آن هدایت شود. برای مثال، مقدار 2 درصورت امکان ۲ ورودی سابقه را به جلو پیمایش می‌کند؛ مقدار -3 ۳ ورودی را به عقب پیمایش می‌کند.

  • تماس برگشتی

    تابع اختیاری

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

    (success: boolean) => void

    • موفقیت‌آمیز

      بولی

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

insertCSS()

chrome.webviewTag.insertCSS(
  details: InjectDetails,
  callback?: function,
)
: void

CSS را به صفحه مهمان تزریق می‌کند.

پارامترها

  • جزئیات

    جزئیات CSS برای درج.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

isAudioMuted()

Chrome نسخه ۶۲ به بالا
chrome.webviewTag.isAudioMuted(
  callback: function,
)
: void

پرس‌وجو می‌کند که آیا صدا صامت است یا نه.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (muted: boolean) => void

    • بی‌صدا شد

      بولی

isSpatialNavigationEnabled()

Chrome نسخه ۷۱ به بالا
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)
: void

پرس‌وجو می‌کند که آیا پیمایش فضایی برای نمای وب فعال است یا نه.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (enabled: boolean) => void

    • فعال شد

      بولی

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden(): void

نشان می‌دهد که آیا رشته نماینده کاربر webview توسط webviewTag.setUserAgentOverride لغو شده است یا نه.

loadDataWithBaseUrl()

chrome.webviewTag.loadDataWithBaseUrl(
  dataUrl: string,
  baseUrl: string,
  virtualUrl?: string,
)
: void

نشانی وب داده‌ای را با نشانی وب پایه مشخص‌شده که برای پیوندهای نسبی استفاده می‌شود بار می‌کند. به‌صورت اختیاری، می‌توان یک نشانی وب مجازی ارائه داد تا به‌جای نشانی وب داده به کاربر نشان داده شود.

پارامترها

  • dataUrl

    رشته

    نشانی وب داده برای بار کردن.

  • baseUrl

    رشته

    نشانی وب پایه‌ای که برای پیوندهای نسبی استفاده خواهد شد.

  • virtualUrl

    رشته اختیاری

    نشانی وبی که به کاربر (در نوار نشانی) نمایش داده خواهد شد.

print()

chrome.webviewTag.print(): void

محتوای webview را چاپ می‌کند. این معادل فراخوانی تابع چاپ اسکریپت‌شده از خود webview است.

reload()

chrome.webviewTag.reload(): void

صفحه سطح بالای فعلی را مجدداً بار می‌کند.

removeContentScripts()

Chrome نسخه ۴۴ به بالا
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)
: void

متن‌های محتوا را از webview برمی‌دارد.

مثال زیر «myRule» را که قبلاً اضافه شده بود برمی‌دارد.

webview.removeContentScripts(['myRule']);

می‌توانید همه قوانین را با فراخوانی زیر بردارید:

webview.removeContentScripts();

پارامترها

  • scriptNameList

    رشته[] اختیاری

    فهرستی از نام‌های متن‌های محتوا که برداشته خواهند شد. اگر فهرست خالی باشد، همه متون محتوای اضافه‌شده به webview برداشته خواهد شد.

setAudioMuted()

Chrome نسخه ۶۲ به بالا
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)
: void

وضعیت صامت بودن صدای نمای وب را تنظیم می‌کند.

پارامترها

  • بی‌صدا کردن

    بولی

    مقدار صامت کردن صدا

setSpatialNavigationEnabled()

Chrome نسخه ۷۱ به بالا
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)
: void

وضعیت ناوبری فضایی نمای وب را تنظیم می‌کند.

پارامترها

  • فعال شد

    بولی

    مقدار وضعیت پیمایش فضایی.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)
: void

رشته نماینده کاربر را که webview برای درخواست‌های صفحه مهمان استفاده می‌کند لغو کنید. لغو کردن باعث می‌شود مقادیر سرایند «اشاره‌های کارخواه نماینده کاربر» و مقادیر برگردانده‌شده توسط navigator.userAgentData برای درخواست‌های صفحه مهمان که این لغو کردن برای آن‌ها اعمال شده است خالی باشد.

پارامترها

  • userAgent

    رشته

    رشته نماینده کاربر برای استفاده.

setZoom()

chrome.webviewTag.setZoom(
  zoomFactor: number,
  callback?: function,
)
: void

عامل بزرگ‌نمایی صفحه را تغییر می‌دهد. دامنه و تداوم این تغییر با حالت بزرگ‌نمایی فعلی webview تعیین می‌شود (webviewTag.ZoomMode را ببینید).

پارامترها

  • zoomFactor

    شماره

    عامل بزرگ‌نمایی جدید.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

setZoomMode()

Chrome نسخه ۴۳ و بالاتر
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)
: void

حالت بزرگ‌نمایی webview را تنظیم می‌کند.

پارامترها

  • ZoomMode

    نحوه مدیریت بزرگ‌نمایی را در webview تعریف می‌کند.

  • تماس برگشتی

    تابع اختیاری

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

    () => void

stop()

chrome.webviewTag.stop(): void

بار کردن ناوبری webview فعلی را درصورت درحال انجام بودن متوقف می‌کند.

stopFinding()

chrome.webviewTag.stopFinding(
  action?: StopFindingAction,
)
: void

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

پارامترها

  • کنش

    StopFindingAction اختیاری

    تعیین می‌کند که پس‌از پایان جلسه جستجو، با مطابقت فعال چه کاری انجام شود. clear برجسته‌سازی را از روی مطابقت فعال پاک می‌کند؛ keep مطابقت فعال را برجسته نگه می‌دارد؛ activate مطابقت فعال را برجسته نگه می‌دارد و کلیک کاربر روی آن مطابقت را شبیه‌سازی می‌کند. کنش پیش‌فرض keep است.

terminate()

chrome.webviewTag.terminate(): void

پردازش تولیدکننده تصویر صفحه وب مهمان را به‌اجبار متوقف می‌کند. این کار ممکن است بر چندین برچسب webview در برنامه فعلی تأثیر بگذارد اگر فرایند یکسانی داشته باشند، اما بر برچسب‌های webview در برنامه‌های دیگر تأثیر نخواهد گذاشت.

رویدادها

close

chrome.webviewTag.close.addListener(
  callback: function,
)

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

کد نمونه زیر وقتی مهمان تلاش می‌کند خودش را ببندد، webview را به about:blank هدایت می‌کند.

webview.addEventListener('close', function() {
  webview.src = 'about:blank';
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    () => void

consolemessage

chrome.webviewTag.consolemessage.addListener(
  callback: function,
)

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

کد نمونه زیر همه پیام‌های گزارش را بدون توجه به سطح گزارش یا ویژگی‌های دیگر به کنسول جاسازنده بازارسال می‌کند.

webview.addEventListener('consolemessage', function(e) {
  console.log('Guest page logged a message: ', e.message);
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    (level: number, message: string, line: number, sourceId: string) => void

    • سطح

      شماره

    • پیام

      رشته

    • خط

      شماره

    • sourceId

      رشته

contentload

chrome.webviewTag.contentload.addListener(
  callback: function,
)

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

کد نمونه زیر اندازه قلم پیش‌فرض عنصر body مهمان را پس‌از بار شدن صفحه تغییر می‌دهد:

webview.addEventListener('contentload', function() {
  webview.executeScript({ code: 'document.body.style.fontSize = "42px"' });
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    () => void

dialog

chrome.webviewTag.dialog.addListener(
  callback: function,
)

وقتی پنجره مهمان تلاش می‌کند کادر گفتگوی مقیدی را ازطریق window.alert، window.confirm، یا window.prompt باز کند، فعال می‌شود.

رسیدگی به این رویداد، فرایند مهمان را تا زمانی که هر شنونده رویداد برگردد یا شیء dialog غیرقابل‌دسترس شود (اگر preventDefault() فراخوانی شده باشد) مسدود می‌کند.

رفتار پیش‌فرض لغو کردن کادر گفتگو است.

پارامترها

exit

chrome.webviewTag.exit.addListener(
  callback: function,
)

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

کد نمونه زیر هرگاه صفحه مهمان ازکار بیفتد پیام خداحافظی نشان می‌دهد:

webview.addEventListener('exit', function(e) {
  if (e.reason === 'crash') {
    webview.src = 'data:text/plain,Goodbye, world!';
  }
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    (details: object) => void

    • جزئیات

      شیء

      • processID

        شماره

        شناسه داخلی Chrome برای فرایندی که خارج شده است.

      • دلیل

        رشته‌ای که دلیل خروج را نشان می‌دهد.

findupdate

chrome.webviewTag.findupdate.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => void

    • searchText

      رشته

    • numberOfMatches

      شماره

    • activeMatchOrdinal

      شماره

    • selectionRect
    • لغو شد

      بولی

    • finalUpdate

      رشته

loadabort

chrome.webviewTag.loadabort.addListener(
  callback: function,
)

وقتی بارگیری سطح بالا بدون ثبت شدن لغو شود، فعال می‌شود. پیام خطایی در کنسول چاپ خواهد شد، مگراینکه رویداد به‌طور پیش‌فرض جلوگیری شده باشد.

توجه: وقتی بارگیری منبع لغو می‌شود، رویداد loadabort درنهایت با رویداد loadstop دنبال می‌شود، حتی اگر همه بارگیری‌های انجام‌شده از آخرین رویداد loadstop (درصورت وجود) لغو شده باشند.

توجه: وقتی بار کردن نشانی وب about یا نشانی وب JavaScript لغو شود، loadabort فعال می‌شود و سپس webview به «about:blank» پیمایش می‌کند.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (url: string, isTopLevel: boolean, code: number, reason: LoadAbortReason) => void

    • نشانی وب

      رشته

    • isTopLevel

      بولی

    • کد

      شماره

    • دلیل

loadcommit

chrome.webviewTag.loadcommit.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (url: string, isTopLevel: boolean) => void

    • نشانی وب

      رشته

    • isTopLevel

      بولی

loadredirect

chrome.webviewTag.loadredirect.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (oldUrl: string, newUrl: string, isTopLevel: boolean) => void

    • oldUrl

      رشته

    • newUrl

      رشته

    • isTopLevel

      بولی

loadstart

chrome.webviewTag.loadstart.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (url: string, isTopLevel: boolean) => void

    • نشانی وب

      رشته

    • isTopLevel

      بولی

loadstop

chrome.webviewTag.loadstop.addListener(
  callback: function,
)

وقتی همه بارگیری‌های سطح قاب در صفحه مهمان (ازجمله همه زیرقاب‌های آن) تکمیل شده باشد، فعال می‌شود. این شامل پیمایش در سند فعلی و همچنین بارگیری‌های سطح سند زیرقاب می‌شود، اما شامل بارگیری‌های منبع ناهمگام نمی‌شود. این رویداد هربار که تعداد بارگیری‌های سطح سند از یک (یا بیشتر) به صفر تغییر می‌کند، فعال می‌شود. برای مثال، اگر صفحه‌ای که قبلاً بارگیری آن تمام شده است (یعنی loadstop قبلاً یک‌بار فعال شده است) iframe جدیدی ایجاد می‌کند که صفحه‌ای را بار می‌کند، سپس loadstop دوم زمانی فعال می‌شود که بار شدن صفحه iframe تکمیل شود. این الگو معمولاً در صفحه‌هایی که آگهی بار می‌کنند مشاهده می‌شود.

توجه: وقتی بارگذاری متعهدشده‌ای لغو می‌شود، درنهایت رویداد loadstop به‌دنبال رویداد loadabort می‌آید، حتی اگر همه بارگذاری‌های متعهدشده از آخرین رویداد loadstop (درصورت وجود) لغو شده باشند.

پارامترها

  • تماس برگشتی

    عملکرد

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

    () => void

newwindow

chrome.webviewTag.newwindow.addListener(
  callback: function,
)

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

کد نمونه زیر یک webview جدید در جاساز برای هر پنجره جدید درخواست‌شده ایجاد و پیمایش می‌کند:

webview.addEventListener('newwindow', function(e) {
  var newWebview = document.createElement('webview');
  document.body.appendChild(newWebview);
  e.window.attach(newWebview);
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: WindowOpenDisposition) => void

    • پنجره
    • targetUrl

      رشته

    • initialWidth

      شماره

    • initialHeight

      شماره

    • نام

      رشته

    • windowOpenDisposition

permissionrequest

chrome.webviewTag.permissionrequest.addListener(
  callback: function,
)

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

کد نمونه زیر به صفحه مهمان اجازه می‌دهد به میانای برنامه‌سازی کاربردی webkitGetUserMedia دسترسی داشته باشد. توجه داشته باشید که برنامه‌ای که از این کد نمونه استفاده می‌کند باید خودش اجازه‌های مانیفست audioCapture و/یا videoCapture را مشخص کند:

webview.addEventListener('permissionrequest', function(e) {
  if (e.permission === 'media') {
    e.request.allow();
  }
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    (permission: PermissionType, request: object) => void

responsive

chrome.webviewTag.responsive.addListener(
  callback: function,
)

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

کد نمونه زیر عنصر webview را با محو شدن تدریجی ظاهر یا پنهان می‌کند، بسته به اینکه پاسخگو باشد یا نباشد:

webview.style.webkitTransition = 'opacity 250ms';
webview.addEventListener('unresponsive', function() {
  webview.style.opacity = '0.5';
});
webview.addEventListener('responsive', function() {
  webview.style.opacity = '1';
});

پارامترها

  • تماس برگشتی

    عملکرد

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

    (processID: number) => void

    • processID

      شماره

sizechanged

chrome.webviewTag.sizechanged.addListener(
  callback: function,
)

وقتی محتوای وب جاسازی‌شده ازطریق autosize تغییر اندازه داده شود، فعال می‌شود. فقط درصورت فعال بودن autosize اجرا می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => void

    • oldWidth

      شماره

    • oldHeight

      شماره

    • newWidth

      شماره

    • newHeight

      شماره

unresponsive

chrome.webviewTag.unresponsive.addListener(
  callback: function,
)

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

پارامترها

  • تماس برگشتی

    عملکرد

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

    (processID: number) => void

    • processID

      شماره

zoomchange

chrome.webviewTag.zoomchange.addListener(
  callback: function,
)

وقتی بزرگ‌نمایی صفحه تغییر می‌کند، فعال می‌شود.

پارامترها

  • تماس برگشتی

    عملکرد

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

    (oldZoomFactor: number, newZoomFactor: number) => void

    • oldZoomFactor

      شماره

    • newZoomFactor

      شماره