chrome.webviewTag

תיאור

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

הרשאות

webview

זמינות

ChromeOS בלבד

סוגים

ClearDataOptions

אפשרויות שקובעות אילו נתונים יימחקו על ידי clearData.

מאפיינים

  • מאז

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

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

ClearDataTypeSet

קבוצה של סוגי נתונים. מאפיינים חסרים מפורשים כ-false.

מאפיינים

  • appcache

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

    מטמוני אפליקציות של אתרים.

  • קובץ שמור

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

    ‫Chrome מגרסה 44 ואילך

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

  • קובצי cookie

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

    קובצי ה-Cookie של המחיצה.

  • fileSystems

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

    מערכות קבצים של אתרים.

  • indexedDB

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

    נתוני IndexedDB של אתרים.

  • localStorage

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

    נתונים באחסון המקומי של אתרים.

  • persistentCookies

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

    Chrome 58 ואילך

    קובצי ה-Cookie הקבועים של המחיצה.

  • sessionCookies

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

    Chrome 58 ואילך

    קובצי ה-Cookie הזמניים של המחיצה.

  • webSQL

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

    נתוני WebSQL של אתרים.

ContentScriptDetails

‫Chrome מגרסה 44 ואילך

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

מאפיינים

  • all_frames

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

    אם הערך של all_frames הוא true, המשמעות היא שצריך להחדיר את ה-JavaScript או ה-CSS לכל המסגרות של הדף הנוכחי. כברירת מחדל, הערך של all_frames הוא false וה-JavaScript או ה-CSS מוזרקים רק לפריים העליון.

  • css

    InjectionItems אופציונלי

    קוד ה-CSS או רשימה של קובצי CSS שיוזרקו לדפים תואמים. הסקריפטים האלה מוזרקים לפי הסדר שבו הם מופיעים, לפני שנוצר או מוצג DOM כלשהו בדף.

  • exclude_globs

    string[] אופציונלי

    ההחרגה חלה אחרי ההתאמות, כדי להחריג כתובות URL שתואמות ל-glob הזה. נועד לחקות את מילת המפתח ‎ @exclude של Greasemonkey.

  • exclude_matches

    string[] אופציונלי

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

  • include_globs

    string[] אופציונלי

    מוחל אחרי ההתאמות כדי לכלול רק את כתובות ה-URL שתואמות גם ל-glob הזה. נועד לחקות את מילת המפתח ‎ @include של Greasemonkey.

  • js

    ‫InjectionItems אופציונלי

    קוד JavaScript או רשימה של קובצי JavaScript שיוזרקו לדפים תואמים. הם מוזרקים בסדר שבו הם מופיעים.

  • match_about_blank

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

    אם להוסיף את סקריפט התוכן ב-about:blank וב-about:srcdoc. סקריפטים של תוכן יתווספו לדפים רק כשכתובת ה-URL שהם יורשים תואמת לאחת מהתבניות שהוצהרו בשדה ההתאמות. כתובת ה-URL שעוברת בירושה היא כתובת ה-URL של המסמך שיצר את המסגרת או החלון. אי אפשר להוסיף סקריפטים של תוכן למסגרות בארגז חול.

  • תואם את:

    string[]‎

    מציין לאילו דפים יוזרק סקריפט התוכן הזה.

  • שם

    מחרוזת

    השם של סקריפט התוכן שרוצים להחדיר.

  • run_at

    ‫RunAt אופציונלי

    המועד המוקדם ביותר שבו ה-JavaScript או ה-CSS יתווספו לכרטיסייה. ברירת המחדל היא "document_idle".

ContentWindow

העברת נקודת האחיזה של ההודעות לחלון אורח.

מאפיינים

  • postMessage

    void

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

    האורח יוכל לשלוח תשובות למטמיע על ידי פרסום הודעה אל event.source באירוע ההודעה שהוא מקבל.

    ה-API הזה זהה ל-HTML5 postMessage API לתקשורת בין דפי אינטרנט. הגורם המטמיע יכול להאזין לתשובות על ידי הוספת רכיב event listener מסוג message למסגרת שלו.

    הפונקציה postMessage נראית כך:

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

    • הודעה

      כל

      אובייקט ההודעה שיישלח לאורח.

    • targetOrigin

      מחרוזת

      מציין מה צריך להיות המקור של חלון האורח כדי שהאירוע יישלח.

ContextMenuCreateProperties

‫Chrome מגרסה 44 ואילך

מאפיינים

  • בוצע סימון

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

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

  • הקשרים

    [ContextType, ...ContextType[]] אופציונלי

    רשימת ההקשרים שבהם האפשרות הזו תופיע בתפריט. אם לא מציינים ערך, ברירת המחדל היא ['page'].

  • documentUrlPatterns

    string[] אופציונלי

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

  • פעיל

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

    אם הפריט הזה בתפריט ההקשר מופעל או מושבת. ברירת המחדל היא true.

  • id [מזהה]

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

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

  • parentId

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

    המזהה של פריט התפריט הראשי. המזהה הזה הופך את הפריט לפריט משני של פריט שנוסף קודם לכן.

  • targetUrlPatterns

    string[] אופציונלי

    דומה ל-documentUrlPatterns, אבל מאפשר לסנן על סמך המאפיין src של תגי img/audio/video והמאפיין href של תגי עוגן.

  • title

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

    הטקסט שיוצג בפריט. זהו שדה חובה, אלא אם הערך של type הוא "separator". כשההקשר הוא "בחירה", אפשר להשתמש ב-%s בתוך המחרוזת כדי להציג את הטקסט שנבחר. לדוגמה, אם הערך של הפרמטר הזה הוא "Translate '%s' to Pig Latin" והמשתמש בוחר את המילה "cool", הפריט בתפריט ההקשר של הבחירה הוא "Translate 'cool' to Pig Latin".

  • סוג

    ItemType אופציונלי

    סוג הפריט בתפריט. אם לא מציינים ערך, ברירת המחדל היא "normal".

  • onclick

    void אופציונלי

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

    הפונקציה onclick נראית כך:

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

    • מידע

      מידע על הפריט שנלחץ וההקשר שבו התרחש הקליק.

ContextMenus

‫Chrome מגרסה 44 ואילך

מאפיינים

  • onShow

    Event<functionvoidvoid>

    מופעל לפני הצגת תפריט הקשר ב-webview הזה. אפשר להשתמש בו כדי להשבית את תפריט ההקשר הזה על ידי קריאה ל-event.preventDefault().

    הפונקציה onShow.addListener נראית כך:

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

    • callback

      פונקציה

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

      (event: object) => void

      • אירוע

        אובייקט

        • preventDefault

          void

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

          הפונקציה preventDefault נראית כך:

          () => {...}

  • create

    void

    יוצרת פריט חדש בתפריט ההקשר. שימו לב: אם תתרחש שגיאה במהלך היצירה, יכול להיות שתגלו את זה רק כשהקריאה החוזרת (callback) של היצירה תופעל (הפרטים יהיו ב-runtime.lastError).

    הפונקציה create נראית כך:

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

    • createProperties

      אובייקט

      המאפיינים ששימשו ליצירת הפריט

    • callback

      function optional

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

      () => void

    • החזרות

      מחרוזת | מספר

      המזהה של הפריט החדש שנוצר.

  • remove

    void

    הסרת פריט מתפריט ההקשר.

    הפונקציה remove נראית כך:

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

    • menuItemId

      מחרוזת | מספר

      המזהה של הפריט בתפריט ההקשר שרוצים להסיר.

    • callback

      function optional

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

      () => void

  • removeAll

    void

    הסרה של כל הפריטים בתפריט ההקשר שנוספו ל-webview הזה.

    הפונקציה removeAll נראית כך:

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

    • callback

      function optional

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

      () => void

  • עדכון

    void

    עדכון של פריט בתפריט ההקשר שנוצר בעבר.

    הפונקציה update נראית כך:

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

    • id [מזהה]

      מחרוזת | מספר

      המזהה של הפריט שרוצים לעדכן.

    • updateProperties

      אובייקט

      המאפיינים שצריך לעדכן. מקבלת את אותם ערכים כמו הפונקציה create.

    • callback

      function optional

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

      () => void

ContextMenuUpdateProperties

‫Chrome מגרסה 44 ואילך

מאפיינים

  • בוצע סימון

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

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

  • הקשרים

    [ContextType, ...ContextType[]] אופציונלי

    רשימת ההקשרים שבהם האפשרות הזו תופיע בתפריט.

  • documentUrlPatterns

    string[] אופציונלי

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

  • פעיל

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

    אם הפריט הזה בתפריט ההקשר מופעל או מושבת.

  • parentId

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

    המזהה של פריט התפריט הראשי. המזהה הזה הופך את הפריט לפריט משני של פריט שנוסף קודם לכן. הערה: אי אפשר להגדיר פריט כפריט משני של אחד מהצאצאים שלו.

  • targetUrlPatterns

    string[] אופציונלי

    דומה ל-documentUrlPatterns, אבל מאפשר לסנן על סמך המאפיין src של תגי img/audio/video והמאפיין href של תגי עוגן.

  • title

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

    הטקסט שיוצג בפריט

  • סוג

    ItemType אופציונלי

    סוג הפריט בתפריט.

  • onclick

    void אופציונלי

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

    הפונקציה onclick נראית כך:

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

    • מידע

      מידע על הפריט שנלחץ וההקשר שבו התרחש הקליק.

ContextType

‫Chrome מגרסה 44 ואילך

ההקשרים השונים שבהם תפריט יכול להופיע. ציון הערך "all" שווה ערך לשילוב של כל ההקשרים האחרים.

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

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

הממשק מצורף לאירועי DOM של dialog.

מאפיינים

  • ביטול

    void

    דחיית תיבת הדו-שיח. שווה ערך ללחיצה על "ביטול" בתיבת דו-שיח של confirm או prompt.

    הפונקציה cancel נראית כך:

    () => {...}

  • אישור

    void

    מאשרים את תיבת הדו-שיח. שווה ערך ללחיצה על "אישור" בתיבת דו-שיח של alert, confirm או prompt.

    הפונקציה ok נראית כך:

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

    • תשובה

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

      מחרוזת התגובה שתוצג לאורח כשמאשרים תיבת דו-שיח של prompt.

DialogMessageType

‫Chrome מגרסה 141 ואילך

סוג תיבת הדו-שיח המודאלית שהאורח ביקש.

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

"alert"

"אישור"

"prompt"

DownloadPermissionRequest

סוג האובייקט request שמלווה אירוע DOM מסוג download permissionrequest.

מאפיינים

  • requestMethod

    מחרוזת

    סוג בקשת ה-HTTP (למשל GET) שמשויך לבקשת ההורדה.

  • url

    מחרוזת

    כתובת ה-URL של ההורדה המבוקשת.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-allow.

    הפונקציה deny נראית כך:

    () => {...}

ExitReason

‫Chrome מגרסה 141 ואילך

מחרוזת שמציינת את הסיבה ליציאה.

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

"normal"

"abnormal"

"crashed"

"killed"

"oom killed"

"oom"

"failed to launch"

"integrity failure"

FileSystemPermissionRequest

סוג האובייקט request שמלווה אירוע DOM מסוג filesystem permissionrequest.

מאפיינים

  • url

    מחרוזת

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

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה.

    הפונקציה deny נראית כך:

    () => {...}

FindCallbackResults

מכיל את כל התוצאות של בקשת החיפוש.

מאפיינים

  • activeMatchOrdinal

    number

    המספר הסידורי של ההתאמה הנוכחית.

  • בוטלו

    בוליאני

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

  • numberOfMatches

    number

    מספר הפעמים שהייתה התאמה ל-searchText בדף.

  • selectionRect

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

FindOptions

אפשרויות לבקשת החיפוש.

מאפיינים

  • אחורה

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

    דגל למציאת התאמות בסדר הפוך. ערך ברירת המחדל הוא false.

  • matchCase

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

    דגל להתאמה עם תלות באותיות רישיות. ערך ברירת המחדל הוא false.

FullscreenPermissionRequest

Chrome 43 ואילך

סוג האובייקט request שמלווה אירוע DOM מסוג fullscreen permissionrequest.

מאפיינים

  • origin

    מחרוזת

    מקור המסגרת בתוך webview שיזם את הבקשה למסך מלא.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה.

    הפונקציה deny נראית כך:

    () => {...}

GeolocationPermissionRequest

סוג האובייקט request שמלווה אירוע DOM מסוג geolocation permissionrequest.

מאפיינים

  • url

    מחרוזת

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

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-allow.

    הפונקציה deny נראית כך:

    () => {...}

HidPermissionRequest

‫Chrome מגרסה 125 ואילך

סוג האובייקט request שמלווה אירוע DOM מסוג hid permissionrequest.

מאפיינים

  • url

    מחרוזת

    כתובת ה-URL של המסגרת שמבקשת גישה ל-HID API.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-allow.

    הפונקציה deny נראית כך:

    () => {...}

InjectDetails

פרטי הסקריפט או ה-CSS שצריך להוסיף. צריך להגדיר את מאפיין הקוד או את מאפיין הקובץ, אבל אי אפשר להגדיר את שניהם בו-זמנית.

מאפיינים

  • קוד

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

    קוד JavaScript או CSS להזרקה.

    אזהרה: היזהרו כשאתם משתמשים בפרמטר code. שימוש לא נכון עלול לחשוף את האפליקציה להתקפות פרצת אבטחה XSS‏ (cross-site scripting).

  • קובץ

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

    קובץ JavaScript או CSS להזרקה.

InjectionItems

‫Chrome מגרסה 44 ואילך

סוג הפריט שמוזרק: קוד או קבוצת קבצים.

מאפיינים

  • קוד

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

    קוד JavaScript או CSS שיוזרק לדפים תואמים.

  • קבצים

    string[] אופציונלי

    רשימת קובצי ה-JavaScript או ה-CSS שיוזרקו לדפים תואמים. הם מוזרקים לפי הסדר שבו הם מופיעים במערך הזה.

LoadAbortReason

‫Chrome מגרסה 141 ואילך

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

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

"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

    מחרוזת

    מחרוזת המזהה של הפלאגין.

  • שם

    מחרוזת

    השם המוצג של הפלאגין.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-deny.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה.

    הפונקציה deny נראית כך:

    () => {...}

MediaPermissionRequest

סוג האובייקט request שמלווה אירוע DOM מסוג media permissionrequest.

מאפיינים

  • url

    מחרוזת

    כתובת ה-URL של המסגרת שמבקשת גישה למדיה של המשתמש.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-allow.

    הפונקציה deny נראית כך:

    () => {...}

NewWindow

הממשק מצורף לאירועי DOM של newwindow.

מאפיינים

  • לחבר

    void

    מצרפים את דף היעד המבוקש לרכיב webview קיים.

    הפונקציה attach נראית כך:

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

    • WebView

      אובייקט

      הרכיב webview שאליו צריך לצרף את דף היעד.

  • מחיקה

    void

    לבטל את הבקשה לפתיחת חלון חדש.

    הפונקציה discard נראית כך:

    () => {...}

PermissionType

‫Chrome מגרסה 141 ואילך

סוג ההרשאה המבוקשת.

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

"media"

"geolocation"

"pointerLock"

"הורדה"

"loadplugin"

"filesystem"

"fullscreen"

"hid"

PointerLockPermissionRequest

סוג האובייקט request שמלווה אירוע DOM מסוג pointerLock permissionrequest.

מאפיינים

  • lastUnlockedBySelf

    בוליאני

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

  • url

    מחרוזת

    כתובת ה-URL של המסגרת שמבקשת לנעול את המצביע.

  • userGesture

    בוליאני

    אם נעילת הסמן התבקשה כתוצאה מתנועת קלט של המשתמש.

  • לאפשר

    void

    מאשרים את בקשת ההרשאה.

    הפונקציה allow נראית כך:

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זוהי פעולת ברירת המחדל אם לא מתבצעת קריאה ל-allow.

    הפונקציה deny נראית כך:

    () => {...}

SelectionRect

מתאר מלבן בקואורדינטות של המסך.

הסמנטיקה של ההכלה דומה למערך. כלומר, הקואורדינטה (left, top) נחשבת כמוכלת במלבן, אבל הקואורדינטה (left + width, top) לא.

מאפיינים

  • גובה

    number

    גובה המלבן.

  • שמאלה

    number

    המרחק מהקצה השמאלי של המסך לקצה השמאלי של המלבן.

  • עליון

    number

    המרחק מהקצה העליון של המסך לקצה העליון של המלבן.

  • רוחב

    number

    רוחב המלבן.

StopFindingAction

‫Chrome מגרסה 141 ואילך

ההגדרה קובעת מה לעשות עם ההתאמה הפעילה אחרי שסשן החיפוש הסתיים. clear תנקה את ההדגשה מעל ההתאמה הפעילה; keep תשאיר את ההתאמה הפעילה מודגשת; activate תשאיר את ההתאמה הפעילה מודגשת ותדמה קליק של משתמש על ההתאמה הזו. פעולת ברירת המחדל היא keep.

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

"clear"

"keep"

"activate"

WebRequestEventInterface

‫Chrome מגרסה 44 ואילך

ממשק שמאפשר גישה לאירועי webRequest בדף האורח. ב-API של התוספים chrome.webRequest מפורט מידע על מחזור החיים של 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.

חשוב לזכור שצריך ליצור מופעים של תנאים ופעולות עבור webRequests של 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

‫Chrome מגרסה 141 ואילך

המיקום המבוקש של החלון החדש.

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

"ignore"

"save_to_disk"

"current_tab"

"new_background_tab"

"new_foreground_tab"

"new_window"

"new_popup"

ZoomMode

Chrome 43 ואילך

ההגדרה קובעת איך מתבצעת ההתקרבות ב-webview.

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

"per-origin"
השינויים בזום יישמרו במקור של הדף שבו בוצע הזום, כלומר, הזום יבוצע גם בכל שאר תצוגות ה-WebView באותה מחיצה שמובילות לאותו מקור. בנוסף, per-originהשינויים בזום נשמרים עם המקור, כלומר כשמנווטים לדפים אחרים באותו מקור, כולם יוגדלו באותו גורם זום.

"per-view"
השינויים בזום משפיעים רק על ה-webview הזה, ושינויים בזום ב-webviews אחרים לא ישפיעו על הזום ב-webview הזה. בנוסף, per-viewשינויים במרחק התצוגה מתאפסים במהלך הניווט. ניווט ב-webview תמיד יטען דפים עם גורמי מרחק התצוגה שלהם לכל מקור (במסגרת המחיצה).

"disabled"
השבתה של כל אפשרויות הזום ב-WebView. התוכן יחזור לרמת הזום שמוגדרת כברירת מחדל, והמערכת תתעלם מכל הניסיונות לשנות את הזום.

מאפיינים

contentWindow

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

סוג

contextMenus

‫Chrome מגרסה 44 ואילך

דומה ל-ContextMenus API של Chrome, אבל חל על webview במקום על הדפדפן. משתמשים ב-API של webview.contextMenus כדי להוסיף פריטים לתפריט ההקשר של webview. אתם יכולים לבחור לאילו סוגי אובייקטים יחולו התוספות לתפריט ההקשר, כמו תמונות, היפר-קישורים ודפים.

סוג

request

ממשק שמאפשר גישה לאירועי webRequest בדף האורח.

Methods

addContentScripts()

‫Chrome מגרסה 44 ואילך
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

    function optional

    ‫Chrome מגרסה 44 ואילך

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

    (success: boolean) => void

    • הצלחה

      בוליאני

      מציין אם הניווט הצליח.

canGoBack()

chrome.webviewTag.canGoBack(): boolean

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

החזרות

  • בוליאני

canGoForward()

chrome.webviewTag.canGoForward(): boolean

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

החזרות

  • בוליאני

captureVisibleRegion()

Chrome 50 ומעלה
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)
: void

מצלם את האזור הגלוי של תצוגת האינטרנט.

פרמטרים

  • אפשרויות

    ‫ImageDetails אופציונלי

  • callback

    פונקציה

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

    (dataUrl: string) => void

    • dataUrl

      מחרוזת

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

clearData()

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

מחיקת נתוני הגלישה במחיצה webview.

פרמטרים

  • אפשרויות

    אפשרויות שקובעות אילו נתונים יימחקו.

  • סוגים

    סוגי הנתונים שיימחקו.

  • callback

    function optional

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

    () => void

executeScript()

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

הוספה של קוד JavaScript לדף האורח.

הקוד לדוגמה הבא משתמש בהזרקת סקריפט כדי להגדיר את צבע הרקע של דף האורח לאדום:

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

פרמטרים

  • פרטים

    פרטי הסקריפט שרוצים להריץ.

  • callback

    function optional

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

    (result?: any[]) => void

    • תוצאה

      any[] אופציונלי

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

find()

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

מפעילה בקשה לחיפוש בדף.

פרמטרים

  • searchText

    מחרוזת

    המחרוזת שרוצים למצוא בדף.

  • אפשרויות

    ‫FindOptions אופציונלי

    אפשרויות לבקשת החיפוש.

  • callback

    function optional

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

    (results?: FindCallbackResults) => void

    • תוצאות

      ‫FindCallbackResults אופציונלי

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

forward()

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

מעבר קדימה לרשומה אחת בהיסטוריה, אם אפשר. שווה ערך ל-go(1).

פרמטרים

  • callback

    function optional

    ‫Chrome מגרסה 44 ואילך

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

    (success: boolean) => void

    • הצלחה

      בוליאני

      מציין אם הניווט הצליח.

getAudioState()

Chrome 62 ואילך
chrome.webviewTag.getAudioState(
  callback: function,
)
: void

שליחת שאילתה לגבי מצב האודיו.

פרמטרים

  • callback

    פונקציה

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

    (audible: boolean) => void

    • audible, אודיבל

      בוליאני

getProcessId()

chrome.webviewTag.getProcessId(): number

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

החזרות

  • number

getUserAgent()

chrome.webviewTag.getUserAgent(): string

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

החזרות

  • מחרוזת

getZoom()

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

הפונקציה מחזירה את גורם הזום הנוכחי.

פרמטרים

  • callback

    פונקציה

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

    (zoomFactor: number) => void

    • zoomFactor

      number

      גורם הזום הנוכחי.

getZoomMode()

Chrome 43 ואילך
chrome.webviewTag.getZoomMode(
  callback: function,
)
: void

הפונקציה מחזירה את מצב הזום הנוכחי.

פרמטרים

  • callback

    פונקציה

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

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      מצב הזום הנוכחי של webview.

go()

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

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

פרמטרים

  • relativeIndex

    number

    אינדקס ההיסטוריה היחסי שאליו צריך לנווט את webview. לדוגמה, הערך 2 ינווט קדימה 2 רשומות בהיסטוריה אם אפשר, והערך -3 ינווט אחורה 3 רשומות.

  • callback

    function optional

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

    (success: boolean) => void

    • הצלחה

      בוליאני

      מציין אם הניווט הצליח.

insertCSS()

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

הוספת CSS לדף האורח.

פרמטרים

  • פרטים

    פרטי ה-CSS שרוצים להוסיף.

  • callback

    function optional

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

    () => void

isAudioMuted()

Chrome 62 ואילך
chrome.webviewTag.isAudioMuted(
  callback: function,
)
: void

בודק אם האודיו מושתק.

פרמטרים

  • callback

    פונקציה

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

    (muted: boolean) => void

    • מושתק

      בוליאני

isSpatialNavigationEnabled()

‫Chrome מגרסה 71 ואילך
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)
: void

שאילתה שבודקת אם הניווט המרחבי מופעל ב-WebView.

פרמטרים

  • callback

    פונקציה

    הפרמטר 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 של הנתונים.

פרמטרים

  • dataUrl

    מחרוזת

    כתובת ה-URL של הנתונים שרוצים לטעון.

  • baseUrl

    מחרוזת

    כתובת ה-URL הבסיסית שתשמש לקישורים יחסיים.

  • virtualUrl

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

    כתובת ה-URL שתוצג למשתמש (בסרגל הכתובות).

print()

chrome.webviewTag.print(): void

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

reload()

chrome.webviewTag.reload(): void

טעינה מחדש של הדף הנוכחי ברמה העליונה.

removeContentScripts()

‫Chrome מגרסה 44 ואילך
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)
: void

הסרת סקריפטים של תוכן מ-webview.

בדוגמה הבאה, הכלל "myRule" שנוסף קודם מוסר.

webview.removeContentScripts(['myRule']);

כדי להסיר את כל הכללים, אפשר להפעיל את הפקודה:

webview.removeContentScripts();

פרמטרים

  • scriptNameList

    string[] אופציונלי

    רשימה של שמות של סקריפטים של תוכן שיוסרו. אם הרשימה ריקה, כל הסקריפטים של התוכן שנוספו אל webview יוסרו.

setAudioMuted()

Chrome 62 ואילך
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)
: void

מגדירה את מצב ההשתקה של האודיו ב-WebView.

פרמטרים

  • השתקה

    בוליאני

    ערך השתקת האודיו

setSpatialNavigationEnabled()

‫Chrome מגרסה 71 ואילך
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)
: void

הגדרה של מצב הניווט המרחבי של תצוגת האינטרנט.

פרמטרים

  • פעיל

    בוליאני

    ערך המצב של הניווט המרחבי.

setUserAgentOverride()

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

שינוי מחרוזת סוכן המשתמש שמשמשת את webview לבקשות של דפי אורחים. ההגדרה הזו תגרום לכך שערכי הכותרת של איסוף נתונים מותנה באותות לסוכן המשתמש (UA-CH) והערכים שמוחזרים על ידי navigator.userAgentData יהיו ריקים בבקשות של דפי אורחים שההגדרה הזו חלה עליהם.

פרמטרים

  • userAgent

    מחרוזת

    מחרוזת סוכן המשתמש שבה רוצים להשתמש.

setZoom()

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

משנה את גורם מרחק התצוגה של הדף. ההיקף וההתמדה של השינוי הזה נקבעים לפי מצב הזום הנוכחי של ה-webview (ראו webviewTag.ZoomMode).

פרמטרים

  • zoomFactor

    number

    גורם הזום החדש.

  • callback

    function optional

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

    () => void

setZoomMode()

Chrome 43 ואילך
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)
: void

מגדירה את מצב הזום של webview.

פרמטרים

  • ZoomMode

    ההגדרה הזו קובעת איך מתבצעת ההתקרבות ב-webview.

  • callback

    function optional

    הפרמטר 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

    פונקציה

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

    () => void

consolemessage

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

מופעל כשחלון האורח מתעד הודעה במסוף.

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • שלב

      number

    • הודעה

      מחרוזת

    • קו

      number

    • sourceId

      מחרוזת

contentload

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

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

הקוד לדוגמה הבא משנה את גודל ברירת המחדל של הגופן של רכיב body של האורח אחרי טעינת הדף:

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

פרמטרים

  • callback

    פונקציה

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

    () => void

dialog

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

מופעל כשחלון האורח מנסה לפתוח תיבת דו-שיח מודאלית דרך window.alert,‏ window.confirm או window.prompt.

הטיפול באירוע הזה יחסום את תהליך האורח עד שכל רכיב event listener יחזיר ערך או עד שלא תהיה גישה לאובייקט 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

    פונקציה

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

    (details: object) => void

    • פרטים

      אובייקט

      • processID

        number

        המזהה הפנימי של התהליך שהסתיים ב-Chrome.

      • reason

        מחרוזת שמציינת את הסיבה ליציאה.

findupdate

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • searchText

      מחרוזת

    • numberOfMatches

      number

    • activeMatchOrdinal

      number

    • selectionRect
    • בוטלו

      בוליאני

    • finalUpdate

      מחרוזת

loadabort

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

מופעל כשפעולת טעינה ברמה העליונה בוטלה בלי שהושלמה. הודעת שגיאה תודפס במסוף, אלא אם האירוע מוגדר כ-default-prevented.

הערה: כשביטול של טעינת משאב מתרחש, אחרי אירוע loadabort יופיע בסופו של דבר אירוע loadstop, גם אם כל הטעינות שהתחילו מאז האירוע האחרון של loadstop (אם היו כאלה) בוטלו.

הערה: כשהטעינה של כתובת URL מסוג about או כתובת URL מסוג JavaScript מבוטלת, האירוע loadabort יופעל ואז webview ינווט אל about:blank.

פרמטרים

  • callback

    פונקציה

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

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

    • url

      מחרוזת

    • isTopLevel

      בוליאני

    • קוד

      number

loadcommit

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • url

      מחרוזת

    • isTopLevel

      בוליאני

loadredirect

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

מופעל כשבקשת טעינה ברמה העליונה הופנתה לכתובת URL אחרת.

פרמטרים

  • callback

    פונקציה

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

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

    • oldUrl

      מחרוזת

    • newUrl

      מחרוזת

    • isTopLevel

      בוליאני

loadstart

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • url

      מחרוזת

    • isTopLevel

      בוליאני

loadstop

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

מופעל כשכל הטעינות ברמת המסגרת בדף אורח (כולל כל מסגרות המשנה שלו) הושלמו. הנתון הזה כולל ניווט בתוך המסמך הנוכחי וגם טעינות ברמת המסמך של מסגרות משנה, אבל הוא לא כולל טעינות של משאבים לא סינכרוניים. האירוע הזה מופעל בכל פעם שמספר הטעינות ברמת המסמך משתנה מאחת (או יותר) לאפס. לדוגמה, אם דף שכבר סיים להיטען (כלומר, loadstop כבר הופעל פעם אחת) יוצר iframe חדש שטוען דף, ואז loadstop שני יופעל כשטעינת הדף ב-iframe תושלם. הדפוס הזה נפוץ בדפים שנטענות בהם מודעות.

הערה: כשפעולת טעינה שהתחייבתם אליה מבוטלת, בסופו של דבר יופיע אירוע loadstop אחרי אירוע loadabort, גם אם כל פעולות הטעינה שהתחייבתם אליהן מאז האירוע האחרון של loadstop (אם היו כאלה) בוטלו.

פרמטרים

  • callback

    פונקציה

    הפרמטר 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

    פונקציה

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

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

permissionrequest

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

מופעל כשדף האורח צריך לבקש הרשאה מיוחדת מהמטמיע.

קוד הדוגמה הבא יעניק לדף האורח גישה ל-API של webkitGetUserMedia. שימו לב שאפליקציה שמשתמשת בקוד לדוגמה הזה צריכה לציין בעצמה את הרשאות המניפסט audioCapture ו/או videoCapture:

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

פרמטרים

  • callback

    פונקציה

    הפרמטר 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

    פונקציה

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

    (processID: number) => void

    • processID

      number

sizechanged

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • oldWidth

      number

    • oldHeight

      number

    • newWidth

      number

    • newHeight

      number

unresponsive

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

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

פרמטרים

  • callback

    פונקציה

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

    (processID: number) => void

    • processID

      number

zoomchange

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

מופעל כשמשנים את הזום בדף.

פרמטרים

  • callback

    פונקציה

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

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

    • oldZoomFactor

      number

    • newZoomFactor

      number