chrome.webviewTag

תיאור

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

הרשאות

webview

סוגים

ClearDataOptions

אפשרויות שקובעות אילו נתונים clearData ינקה.

מאפיינים

  • מאז

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

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

ClearDataTypeSet

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

מאפיינים

  • appcache

    boolean אופציונלי

    מאגרי ה-appcache של אתרים.

  • קובץ שמור

    boolean אופציונלי

    גרסה 44 ואילך של Chrome

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

  • קובצי cookie

    boolean אופציונלי

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

  • fileSystems

    boolean אופציונלי

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

  • indexedDB

    boolean אופציונלי

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

  • localStorage

    boolean אופציונלי

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

  • persistentCookies

    boolean אופציונלי

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

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

  • sessionCookies

    boolean אופציונלי

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

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

  • webSQL

    boolean אופציונלי

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

ContentScriptDetails

גרסה 44 ואילך של Chrome

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

מאפיינים

  • all_frames

    boolean אופציונלי

    אם הערך של 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

    boolean אופציונלי

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

  • תואם את:

    string[]

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

  • שם

    מחרוזת

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

  • run_at

    RunAt אופציונלי

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

ContentWindow

חלון של הודעות לאורחים.

מאפיינים

  • postMessage

    void

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

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

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

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

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

    • הודעה

      כל

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

    • targetOrigin

      מחרוזת

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

ContextMenuCreateProperties

גרסה 44 ואילך של Chrome

מאפיינים

  • בוצע סימון

    boolean אופציונלי

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

  • הקשרים

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

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

  • documentUrlPatterns

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

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

  • פעיל

    boolean אופציונלי

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

  • id [מזהה]

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • סוג

    ItemType אופציונלי

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

  • onclick

    void optional

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

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

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

    • מידע

      מידע על הפריט שאליו בוצע הקליק ועל ההקשר שבו בוצע הקליק.

ContextMenus

גרסה 44 ואילך של Chrome

מאפיינים

  • onShow

    Event<functionvoidvoid>

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

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

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

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

      פונקציה

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

      (event: object) => void

      • אירוע

        אובייקט

        • preventDefault

          void

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

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

          () => {...}

  • create

    void

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

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

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

    • createProperties

      אובייקט

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

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

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

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

      () => void

    • החזרות

      מחרוזת | מספר

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

  • remove

    void

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

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

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

    • menuItemId

      מחרוזת | מספר

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

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

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

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

      () => void

  • removeAll

    void

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

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

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

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

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

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

      () => void

  • עדכון

    void

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

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

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

    • id [מזהה]

      מחרוזת | מספר

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

    • updateProperties

      אובייקט

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

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

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

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

      () => void

ContextMenuUpdateProperties

גרסה 44 ואילך של Chrome

מאפיינים

  • בוצע סימון

    boolean אופציונלי

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

  • הקשרים

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

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

  • documentUrlPatterns

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

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

  • פעיל

    boolean אופציונלי

    מצב ההפעלה של הפריט בתפריט ההקשר.

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • סוג

    ItemType אופציונלי

    הסוג של פריט התפריט.

  • onclick

    void optional

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

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

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

    • מידע

      מידע על הפריט שאליו בוצע הקליק ועל ההקשר שבו בוצע הקליק.

ContextType

גרסה 44 ואילך של Chrome

ההקשרים השונים שבהם תפריט יכול להופיע. ציון הערך '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.

DownloadPermissionRequest

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

מאפיינים

  • requestMethod

    מחרוזת

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

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-allow.

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

    () => {...}

FileSystemPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

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

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

    () => {...}

FindCallbackResults

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

מאפיינים

  • activeMatchOrdinal

    number

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

  • בוטלו

    בוליאני

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

  • numberOfMatches

    number

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

  • selectionRect

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

FindOptions

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

מאפיינים

  • אחורה

    boolean אופציונלי

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

  • matchCase

    boolean אופציונלי

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

FullscreenPermissionRequest

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

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

מאפיינים

  • מקור

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

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

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

    () => {...}

GeolocationPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-allow.

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

    () => {...}

HidPermissionRequest

גרסה 125 ואילך של Chrome

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-allow.

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

    () => {...}

InjectDetails

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

מאפיינים

  • קוד

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

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

    אזהרה: חשוב להשתמש בזהירות בפרמטר code. שימוש שגוי בו עלול לחשוף את האפליקציה להתקפות XSS (הרצת סקריפט באתר אחר).

  • קובץ

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

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

InjectionItems

גרסה 44 ואילך של Chrome

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

מאפיינים

  • קוד

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

    קוד JavaScript או CSS שרוצים להחדיר לדפים תואמים.

  • קבצים

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

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

LoadPluginPermissionRequest

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

מאפיינים

  • מזהה

    מחרוזת

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

  • שם

    מחרוזת

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

  • לאפשר

    void

    מאשרים את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-deny.

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

    () => {...}

  • דחייה

    void

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

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

    () => {...}

MediaPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-allow.

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

    () => {...}

NewWindow

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

מאפיינים

  • לחבר

    void

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

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

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

    • webview

      אובייקט

      אלמנט webview שאליו צריך לצרף את דף היעד.

  • מחיקה

    void

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

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

    () => {...}

PointerLockPermissionRequest

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

מאפיינים

  • lastUnlockedBySelf

    בוליאני

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

  • כתובת אתר

    מחרוזת

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

  • userGesture

    בוליאני

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

  • לאפשר

    void

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

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

    () => {...}

  • דחייה

    void

    לדחות את בקשת ההרשאה. זו התנהגות ברירת המחדל אם לא קוראים ל-allow.

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

    () => {...}

SelectionRect

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

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

מאפיינים

  • גובה

    number

    גובה המלבן.

  • נשארו

    number

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

  • עליון

    number

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

  • רוחב

    number

    רוחב המלבן.

WebRequestEventInterface

גרסה 44 ואילך של Chrome

ממשק שמספק גישה לאירועי webRequest בדף האורח. מידע נוסף על מחזור החיים של webRequest ועל מושגים קשורים זמין ב-API של התוספים chrome.webRequest. הערה: האירוע chrome.webRequest.onActionIgnored לא נתמך בתצוגות אינטרנט.

כדי להמחיש את ההבדל בין השימוש ב-webRequest API של התוספים לבין השימוש ב-webRequest API של הדפים, אפשר להיעזר בדוגמת הקוד הבאה, שחוסמת כל בקשה של אורחים לכתובות URL שתואמות ל-*://www.evil.com/*:

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

בנוסף, הממשק הזה תומך בכללי webRequest מוצהריים באמצעות אירועי onRequest ו-onMessage. פרטים על ה-API זמינים בכתובת declarativeWebRequest.

שימו לב שצריך ליצור תנאים ופעולות של בקשות 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]);

ZoomMode

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

הגדרת אופן הטיפול בהגדלת התצוגה ב-webview.

Enum

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

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

'disabled'
השבתה של כל פעולות הזום ב-WebView. התוכן יחזור לרמת הזום שמוגדרת כברירת מחדל, וכל ניסיונות לשינוי הזום יי игнорו.

מאפיינים

contentWindow

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

סוג

contextMenus

גרסה 44 ואילך של Chrome

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

סוג

request

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

Methods

addContentScripts()

גרסה 44 ואילך של Chrome
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

הוספת כללי הזרקה של סקריפטים של תוכן ל-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,
)

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

פרמטרים

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

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

    גרסה 44 ואילך של Chrome

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

    (success: boolean) => void

    • הצלחה

      בוליאני

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

canGoBack()

chrome.webviewTag.canGoBack()

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

החזרות

  • בוליאני

canGoForward()

chrome.webviewTag.canGoForward()

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

החזרות

  • בוליאני

captureVisibleRegion()

גרסה 50 ואילך של Chrome
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

צילום האזור הגלוי ב-WebView.

פרמטרים

  • אפשרויות

    ImageDetails אופציונלי

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

    פונקציה

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

    (dataUrl: string) => void

    • dataUrl

      מחרוזת

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

clearData()

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

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

פרמטרים

  • אפשרויות

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

  • סוגים

    סוגי הנתונים שרוצים לנקות.

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

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

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

    () => void

executeScript()

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

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

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

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

פרמטרים

  • פרטים

    פרטי הסקריפט להפעלה.

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

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

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

    (result?: any[]) => void

    • תוצאה

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

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

find()

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

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

פרמטרים

  • searchText

    מחרוזת

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

  • אפשרויות

    FindOptions אופציונלי

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

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

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

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

    (results?: FindCallbackResults) => void

    • תוצאות

      FindCallbackResults אופציונלי

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

forward()

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

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

פרמטרים

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

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

    גרסה 44 ואילך של Chrome

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

    (success: boolean) => void

    • הצלחה

      בוליאני

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

getAudioState()

Chrome מגרסה 62 ואילך
chrome.webviewTag.getAudioState(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (audible: boolean) => void

    • audible, אודיבל

      בוליאני

getProcessId()

chrome.webviewTag.getProcessId()

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

החזרות

  • number

getUserAgent()

chrome.webviewTag.getUserAgent()

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

החזרות

  • מחרוזת

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (zoomFactor: number) => void

    • zoomFactor

      number

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

getZoomMode()

Chrome מגרסה 43 ואילך
chrome.webviewTag.getZoomMode(
  callback: function,
)

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

פרמטרים

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

    פונקציה

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

    (ZoomMode: ZoomMode) => void

    • ZoomMode

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

go()

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

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

פרמטרים

  • relativeIndex

    number

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

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

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

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

    (success: boolean) => void

    • הצלחה

      בוליאני

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

insertCSS()

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

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

פרמטרים

  • פרטים

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

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

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

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

    () => void

isAudioMuted()

Chrome מגרסה 62 ואילך
chrome.webviewTag.isAudioMuted(
  callback: function,
)

שאילתות לגבי ההשתקה של האודיו.

פרמטרים

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

    פונקציה

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

    (muted: boolean) => void

    • הושתק

      בוליאני

isSpatialNavigationEnabled()

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

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

פרמטרים

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

    פונקציה

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

    (enabled: boolean) => void

    • פעיל

      בוליאני

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

מציין אם מחרוזת סוכן המשתמש של webview הוחלפה על ידי webviewTag.setUserAgentOverride או לא.

loadDataWithBaseUrl()

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

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

פרמטרים

  • dataUrl

    מחרוזת

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

  • baseUrl

    מחרוזת

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

  • virtualUrl

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

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

print()

chrome.webviewTag.print()

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

reload()

chrome.webviewTag.reload()

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

removeContentScripts()

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

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

בדוגמה הבאה מסירים את 'myRule' שנוסף קודם.

webview.removeContentScripts(['myRule']);

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

webview.removeContentScripts();

פרמטרים

  • scriptNameList

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

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

setAudioMuted()

Chrome מגרסה 62 ואילך
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

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

פרמטרים

  • השתקה

    בוליאני

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

setSpatialNavigationEnabled()

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

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

פרמטרים

  • פעיל

    בוליאני

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

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

שינוי מחרוזת סוכן המשתמש שמשמשת את webview לבקשות של דפי אורחים. שינוי מברירת המחדל יגרום לערכים של הכותרת User-Agent Client Hint ולערכים שמוחזרים על ידי navigator.userAgentData להיות ריקים בבקשות לדפי אורחים שבהן השינוי מברירת המחדל הזה חל.

פרמטרים

  • userAgent

    מחרוזת

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

setZoom()

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

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

פרמטרים

  • zoomFactor

    number

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

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

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

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

    () => void

setZoomMode()

Chrome מגרסה 43 ואילך
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

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

פרמטרים

  • ZoomMode

    הגדרת אופן הטיפול בהגדלת התצוגה ב-webview.

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

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

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

    () => void

stop()

chrome.webviewTag.stop()

עצירת הטעינה של הניווט הנוכחי ב-webview, אם הוא מתבצע.

stopFinding()

chrome.webviewTag.stopFinding(
  action?: "clear"
 | "keep"
 | "activate"
,
)

סיום סשן החיפוש הנוכחי (ניקוי כל ההדגשות) וביטול כל בקשות החיפוש הקיימות.

פרמטרים

  • פעולה

    "clear"
     | "keep"
     | "activate"
     אופציונלי

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

terminate()

chrome.webviewTag.terminate()

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

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

ברירת המחדל היא ביטול תיבת הדו-שיח.

פרמטרים

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

    פונקציה

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

    (messageType: "alert" 
     | "confirm"
     | "prompt"
    , messageText: string, dialog: DialogController) => void

    • messageType

      "alert"
       | "confirm"
       | "prompt"

    • messageText

      מחרוזת

    • תיבת דו-שיח

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 נראה כך:

    (processID: number, reason: "normal" 
     | "abnormal"
     | "crash"
     | "kill"
    ) => void

    • processID

      number

    • סיבה

      "normal"
       | "abnormal"
       | "crash"
       | "kill"

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,
)

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

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

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

פרמטרים

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

    פונקציה

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

    (url: string, isTopLevel: boolean, code: number, reason: "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"
    ) => void

    • כתובת אתר

      מחרוזת

    • isTopLevel

      בוליאני

    • קוד

      number

    • סיבה

      "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"

loadcommit

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

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

פרמטרים

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

    פונקציה

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

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

    • כתובת אתר

      מחרוזת

    • 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

    • כתובת אתר

      מחרוזת

    • isTopLevel

      בוליאני

loadstop

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

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

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

פרמטרים

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

    פונקציה

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

    () => void

newwindow

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

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

הקוד לדוגמה הבא יוצר webview חדש ב-embedder לכל חלון חדש שנבקש, ומנווט אליו:

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: "ignore" 
     | "save_to_disk"
     | "current_tab"
     | "new_background_tab"
     | "new_foreground_tab"
     | "new_window"
     | "new_popup"
    ) => void

    • חלון
    • targetUrl

      מחרוזת

    • initialWidth

      number

    • initialHeight

      number

    • שם

      מחרוזת

    • windowOpenDisposition

      "ignore"
       | "save_to_disk"
       | "current_tab"
       | "new_background_tab"
       | "new_foreground_tab"
       | "new_window"
       | "new_popup"

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: "media" 
     | "geolocation"
     | "pointerLock"
     | "download"
     | "loadplugin"
     | "filesystem"
     | "fullscreen"
     | "hid"
    , request: object) => void

    • הרשאה

      "media"
       | "geolocation"
       | "pointerLock"
       | "download"
       | "loadplugin"
       | "filesystem"
       | "fullscreen"
       | "hid"

    • בקשה

      אובייקט

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