chrome.webviewTag

توضیحات

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

مجوزها

webview

انواع

ClearDataOptions

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

خواص

  • از آنجایی که

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

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

ClearDataTypeSet

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

خواص

  • اپ‌کَش

    بولی اختیاری

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

  • حافظه نهان

    بولی اختیاری

    کروم ۴۴+

    از کروم ۴۳ به بعد. حافظه پنهان مرورگر. توجه: هنگام حذف داده‌ها، این کار کل حافظه پنهان را پاک می‌کند؛ این محدود به محدوده‌ای که شما مشخص می‌کنید نیست.

  • کوکی‌ها

    بولی اختیاری

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

  • سیستم‌های فایل

    بولی اختیاری

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

  • پایگاه داده فهرست شده

    بولی اختیاری

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

  • ذخیره‌سازی محلی

    بولی اختیاری

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

  • کوکی‌های ماندگار

    بولی اختیاری

    کروم ۵۸+

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

  • کوکی‌های جلسه

    بولی اختیاری

    کروم ۵۸+

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

  • وب اس کیو ال

    بولی اختیاری

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

ContentScriptDetails

کروم ۴۴+

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

خواص

  • همه_فریم‌ها

    بولی اختیاری

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

  • سی‌اس‌اس

    موارد تزریق اختیاری

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

  • حذف_globها

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

    پس از تطابق‌ها اعمال می‌شود تا URLهایی که با این glob مطابقت دارند، حذف شوند. هدف از این کار شبیه‌سازی کلمه کلیدی @exclude Greasemonkey است.

  • موارد استثنا

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

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

  • شامل_globها

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

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

  • جی‌اس

    موارد تزریق اختیاری

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

  • match_about_blank

    بولی اختیاری

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

  • مسابقات

    رشته[]

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

  • نام

    رشته

    نام اسکریپت محتوایی که قرار است تزریق شود.

  • اجرا_در

    اجرای اختیاری

    زودترین زمانی که جاوا اسکریپت یا CSS به تب تزریق شود. مقدار پیش‌فرض "document_idle" است.

ContentWindow

مدیریت پیام‌رسانی به پنجره مهمان.

خواص

  • پستپیام

    باطل

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

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

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

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

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

    • پیام

      هر

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

    • مبدا هدف

      رشته

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

ContextMenuCreateProperties

کروم ۴۴+

خواص

  • بررسی شده

    بولی اختیاری

    حالت اولیه‌ی یک چک‌باکس یا آیتم رادیویی: برای موارد انتخاب‌شده مقدار true و برای موارد انتخاب‌نشده مقدار false را نشان می‌دهد. در هر زمان، فقط می‌توان یک آیتم رادیویی را در یک گروه مشخص از آیتم‌های رادیویی انتخاب کرد.

  • زمینه‌ها

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

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

  • الگوهای documentUrl

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

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

  • فعال شده

    بولی اختیاری

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

  • شناسه

    رشته اختیاری

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

  • شناسه والدین

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

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

  • الگوهای targetUrl

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

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

  • عنوان

    رشته اختیاری

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

  • نوع

    نوع کالا اختیاری

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

  • کلیک

    اختیاری باطل

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

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

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

    • اطلاعات

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

ContextMenus

کروم ۴۴+

خواص

  • روی نمایش

    رویداد<functionvoidvoid>

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

    تابع onShow.addListener به شکل زیر است:

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

    • تماس برگشتی

      تابع

      پارامتر callback به شکل زیر است:

      (event: object) => void

      • رویداد

        شیء

        • preventپیش‌فرض

          باطل

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

          تابع preventDefault به شکل زیر است:

          () => {...}

  • ایجاد کردن

    باطل

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

    تابع create به شکل زیر است:

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

    • ایجاد ویژگی‌ها

      شیء

      ویژگی‌های مورد استفاده برای ایجاد آیتم

    • تماس برگشتی

      تابع اختیاری

      پارامتر callback به شکل زیر است:

      () => void

    • بازده

      رشته | عدد

      شناسه‌ی آیتم تازه ایجاد شده.

  • حذف

    باطل

    یک آیتم از منوی زمینه را حذف می‌کند.

    تابع remove به شکل زیر است:

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

    • شناسه آیتم منو

      رشته | عدد

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

    • تماس برگشتی

      تابع اختیاری

      پارامتر callback به شکل زیر است:

      () => void

  • حذف همه

    باطل

    تمام موارد منوی زمینه اضافه شده به این webview حذف می‌کند.

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

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

    • تماس برگشتی

      تابع اختیاری

      پارامتر callback به شکل زیر است:

      () => void

  • به‌روزرسانی

    باطل

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

    تابع update به شکل زیر است:

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

    • شناسه

      رشته | عدد

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

    • به‌روزرسانی‌ها

      شیء

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

    • تماس برگشتی

      تابع اختیاری

      پارامتر callback به شکل زیر است:

      () => void

ContextMenuUpdateProperties

کروم ۴۴+

خواص

  • بررسی شده

    بولی اختیاری

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

  • زمینه‌ها

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

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

  • الگوهای documentUrl

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

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

  • فعال شده

    بولی اختیاری

    فعال یا غیرفعال بودن این آیتم منوی زمینه.

  • شناسه والدین

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

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

  • الگوهای targetUrl

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

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

  • عنوان

    رشته اختیاری

    متنی که قرار است در آیتم نمایش داده شود

  • نوع

    نوع کالا اختیاری

    نوع آیتم منو.

  • کلیک

    اختیاری باطل

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

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

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

    • اطلاعات

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

ContextType

کروم ۴۴+

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

شمارشی

«همه»

«صفحه»

"قاب"

"انتخاب"

«پیوند»

«قابل ویرایش»

«تصویر»

«ویدئو»

"صوتی"

DialogController

رابط متصل به رویدادهای DOM dialog .

خواص

  • لغو

    باطل

    کادر محاوره‌ای را رد کنید. معادل کلیک روی لغو در کادر محاوره‌ای confirm یا prompt .

    تابع cancel به شکل زیر است:

    () => {...}

  • باشه

    باطل

    پذیرفتن کادر محاوره‌ای. معادل کلیک کردن روی تأیید در یک کادر محاوره‌ای alert ، confirm یا prompt .

    تابع ok به شکل زیر است:

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

    • پاسخ

      رشته اختیاری

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

DialogMessageType

کروم ۱۴۱+

نوع پنجره محاوره‌ای مورد درخواست مهمان.

شمارشی

"هشدار"

"تأیید کردن"

"سریع"

DownloadPermissionRequest

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

خواص

  • درخواستمتد

    رشته

    نوع درخواست HTTP (مثلاً GET ) مرتبط با درخواست دانلود.

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی دانلود درخواستی.

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

ExitReason

کروم ۱۴۱+

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

شمارشی

"عادی"

"غیرطبیعی"

"سقوط کرد"

«کشته شده»

"اوم کشته شد"

"اوم"

«راه‌اندازی ناموفق بود»

«شکست در صداقت»

FileSystemPermissionRequest

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

خواص

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی (URL) فریمی که درخواست دسترسی به سیستم فایل محلی را دارد.

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

FindCallbackResults

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

خواص

  • activeMatchOrdinal

    شماره

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

  • لغو شد

    بولی

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

  • تعداد تطابق‌ها

    شماره

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

  • انتخاب مستقیم

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

FindOptions

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

خواص

  • عقب مانده

    بولی اختیاری

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

  • مورد تطبیق

    بولی اختیاری

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

FullscreenPermissionRequest

کروم ۴۳+

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

خواص

  • منشأ

    رشته

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

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

GeolocationPermissionRequest

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

خواص

  • آدرس اینترنتی

    رشته

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

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

HidPermissionRequest

کروم ۱۲۵+

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

خواص

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی (URL) فریمی که درخواست دسترسی به HID API را دارد.

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

InjectDetails

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

خواص

  • کد

    رشته اختیاری

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

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

  • فایل

    رشته اختیاری

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

InjectionItems

کروم ۴۴+

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

خواص

  • کد

    رشته اختیاری

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

  • فایل‌ها

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

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

LoadAbortReason

کروم ۱۴۱+

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

شمارشی

«خطا_سقط شد»

"خطا در آدرس اینترنتی"

"طرح_آدرس_غیرمجاز_خطا"

"خطا_مسدود_شده_توسط_مشتری"

"آدرس_خطا_غیرقابل_دسترس"

"پاسخ_خالی"

"فایل_خطا_یافت_نشد"

"خطای_آدرس_ناشناخته_ERR"

LoadPluginPermissionRequest

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

خواص

  • شناسه

    رشته

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

  • نام

    رشته

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

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

MediaPermissionRequest

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

خواص

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی (URL) فریمی که درخواست دسترسی به رسانه کاربر را دارد.

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

NewWindow

رابط کاربری به رویدادهای DOM newwindow متصل است.

خواص

  • ضمیمه کردن

    باطل

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

    تابع attach به شکل زیر است:

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

    • نمای وب

      شیء

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

  • دور انداختن

    باطل

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

    تابع discard به شکل زیر است:

    () => {...}

PermissionType

کروم ۱۴۱+

نوع مجوز درخواستی.

شمارشی

«رسانه»

"موقعیت جغرافیایی"

"قفل اشاره‌گر"

"دانلود"

"بارگذاری افزونه"

"سیستم فایل"

"تمام صفحه"

"پنهان"

PointerLockPermissionRequest

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

خواص

  • آخرین قفل‌گشایی‌شده توسط خود

    بولی

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

  • آدرس اینترنتی

    رشته

    آدرس اینترنتی (URL) فریمی که درخواست قفل اشاره‌گر را دارد.

  • ژست کاربر

    بولی

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

  • اجازه دادن

    باطل

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

    تابع allow به شکل زیر است:

    () => {...}

  • انکار کردن

    باطل

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

    تابع deny به شکل زیر است:

    () => {...}

SelectionRect

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

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

خواص

  • ارتفاع

    شماره

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

  • چپ

    شماره

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

  • بالا

    شماره

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

  • عرض

    شماره

    عرض مستطیل.

StopFindingAction

کروم ۱۴۱+

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

شمارشی

"روشن"

«نگه داشتن»

"فعال کردن"

WebRequestEventInterface

کروم ۴۴+

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

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

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

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

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

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

WindowOpenDisposition

کروم ۱۴۱+

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

شمارشی

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

"ذخیره_در_دیسک"

"برگه_فعلی"

"تب_زمینه_جدید"

"تب_پیش_زمینه_جدید"

"پنجره_جدید"

"پنجره_جدید"

ZoomMode

کروم ۴۳+

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

شمارشی

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

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

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

خواص

contentWindow

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

contextMenus

کروم ۴۴+

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

request

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

روش‌ها

addContentScripts()

کروم ۴۴+
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) است.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    کروم ۴۴+

    پارامتر callback به شکل زیر است:

    (success: boolean) => void

    • موفقیت

      بولی

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

canGoBack()

chrome.webviewTag.canGoBack(): boolean

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

بازگشت‌ها

  • بولی

canGoForward()

chrome.webviewTag.canGoForward(): boolean

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

بازگشت‌ها

  • بولی

captureVisibleRegion()

کروم ۵۰+
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)
: void

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

پارامترها

  • گزینه‌ها

    جزئیات تصویر اختیاری

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (dataUrl: string) => void

    • آدرس داده

      رشته

      یک URL داده که تصویری از ناحیه قابل مشاهده تب گرفته شده را رمزگذاری می‌کند. ممکن است برای نمایش به ویژگی 'src' یک عنصر تصویر HTML اختصاص داده شود.

clearData()

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

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

پارامترها

executeScript()

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

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

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

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

پارامترها

  • جزئیات اسکریپتی که قرار است اجرا شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است:

    (result?: any[]) => void

    • نتیجه

      هر [] اختیاری

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

find()

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

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

پارامترها

  • متن جستجو

    رشته

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

  • گزینه‌ها

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است:

    (results?: FindCallbackResults) => void

    • نتایج

      FindCallbackResults اختیاری است

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

forward()

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

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

پارامترها

  • تماس برگشتی

    تابع اختیاری

    کروم ۴۴+

    پارامتر callback به شکل زیر است:

    (success: boolean) => void

    • موفقیت

      بولی

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

getAudioState()

کروم ۶۲+
chrome.webviewTag.getAudioState(
  callback: function,
)
: void

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (audible: boolean) => void

    • قابل شنیدن

      بولی

getProcessId()

chrome.webviewTag.getProcessId(): number

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

بازگشت‌ها

  • شماره

getUserAgent()

chrome.webviewTag.getUserAgent(): string

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

بازگشت‌ها

  • رشته

getZoom()

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (zoomFactor: number) => void

    • زوم فاکتور

      شماره

      ضریب بزرگنمایی فعلی.

getZoomMode()

کروم ۴۳+
chrome.webviewTag.getZoomMode(
  callback: function,
)
: void

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (ZoomMode: ZoomMode) => void

    • حالت زوم

      حالت بزرگنمایی فعلی webview .

go()

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

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

پارامترها

  • شاخص نسبی

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است:

    (success: boolean) => void

    • موفقیت

      بولی

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

insertCSS()

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

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

پارامترها

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است:

    () => void

isAudioMuted()

کروم ۶۲+
chrome.webviewTag.isAudioMuted(
  callback: function,
)
: void

پرس‌وجو می‌کند که آیا صدا قطع شده است یا خیر.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (muted: boolean) => void

    • خاموش

      بولی

isSpatialNavigationEnabled()

کروم ۷۱+
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

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

پارامترها

  • آدرس داده

    رشته

    آدرس اینترنتی داده برای بارگذاری.

  • آدرس پایه

    رشته

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

  • آدرس مجازی

    رشته اختیاری

    آدرس اینترنتی (URL) که به کاربر نمایش داده می‌شود (در نوار آدرس).

print()

chrome.webviewTag.print(): void

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

reload()

chrome.webviewTag.reload(): void

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

removeContentScripts()

کروم ۴۴+
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)
: void

اسکریپت‌های محتوا را از یک webview حذف می‌کند.

مثال زیر "myRule" را که قبلاً اضافه شده بود، حذف می‌کند.

webview.removeContentScripts(['myRule']);

شما می‌توانید با تماس با شماره زیر، تمام قوانین را حذف کنید:

webview.removeContentScripts();

پارامترها

  • فهرست نام اسکریپت

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

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

setAudioMuted()

کروم ۶۲+
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)
: void

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

پارامترها

  • بی‌صدا کردن

    بولی

    مقدار صدا را بی‌صدا کنید

setSpatialNavigationEnabled()

کروم ۷۱+
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)
: void

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

پارامترها

  • فعال شده

    بولی

    مقدار وضعیت ناوبری فضایی.

setUserAgentOverride()

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

رشته عامل کاربر که توسط webview برای درخواست‌های صفحه مهمان استفاده می‌شود را لغو کنید. لغو کردن باعث می‌شود مقادیر هدر User-Agent Client Hint و مقادیر برگردانده شده توسط navigator.userAgentData برای درخواست‌های صفحه مهمان که این لغو روی آنها اعمال می‌شود، خالی باشند.

پارامترها

  • کاربر عامل

    رشته

    رشته‌ی عامل کاربر مورد استفاده.

setZoom()

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

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

پارامترها

  • زوم فاکتور

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است:

    () => void

setZoomMode()

کروم ۴۳+
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)
: void

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

پارامترها

  • حالت زوم

    نحوه مدیریت بزرگنمایی در 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

    • سطح

      شماره

    • پیام

      رشته

    • خط

      شماره

    • شناسه منبع

      رشته

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 یک پنجره محاوره‌ای modal باز کند.

مدیریت این رویداد، فرآیند مهمان را تا زمانی که هر شنونده رویداد بازگردد یا شیء 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

    • جزئیات

      شیء

      • شناسه فرآیند

        شماره

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

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

findupdate

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

    • متن جستجو

      رشته

    • تعداد تطابق‌ها

      شماره

    • activeMatchOrdinal

      شماره

    • انتخاب مستقیم
    • لغو شد

      بولی

    • به‌روزرسانی نهایی

      رشته

loadabort

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

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

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

نکته: وقتی بارگذاری یک URL مربوط به about یا یک URL مربوط به جاوا اسکریپت متوقف می‌شود، loadabort اجرا می‌شود و سپس webview به 'about:blank' هدایت می‌شود.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

loadcommit

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

    • آدرس اینترنتی

      رشته

    • isTopLevel

      بولی

loadredirect

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

    • آدرس قدیمی

      رشته

    • آدرس جدید

      رشته

    • 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

permissionrequest

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

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

کد مثال زیر به صفحه مهمان دسترسی به webkitGetUserMedia API را اعطا می‌کند. توجه داشته باشید که برنامه‌ای که از این کد مثال استفاده می‌کند، باید مجوزهای مانیفست 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

    • شناسه فرآیند

      شماره

sizechanged

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

    • oldWidth

      شماره

    • ارتفاع قدیمی

      شماره

    • عرض جدید

      شماره

    • ارتفاع جدید

      شماره

unresponsive

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

    (processID: number) => void

    • شناسه فرآیند

      شماره

zoomchange

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

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

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است:

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

    • فاکتور زوم قدیمی

      شماره

    • فاکتور بزرگنمایی جدید

      شماره