chrome.webviewTag

תיאור

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

הרשאות

webview

סוגים

ClearDataOptions

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

מאפיינים

  • מאז

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

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

ClearDataTypeSet

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

מאפיינים

  • מטמון אפליקציות

    ערך בוליאני אופציונלי

    אתרים appcaches.

  • קובץ שמור

    ערך בוליאני אופציונלי

    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 שתואמות לכדור הארץ הזה. נועדה לבצע אמולציה של מילת המפתח @excluded Graeasemonkey.

  • exclude_matches

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

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

  • include_globs

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

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

  • JavaScript

    InjectionItems אופציונלי

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

  • match_about_blank

    ערך בוליאני אופציונלי

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

  • תואם את:

    String[]

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

  • שם

    מחרוזת

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

  • run_at

    RunAt אופציונלי

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

ContentWindow

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

מאפיינים

  • postMessage

    ריק

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

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

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

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

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

    • הודעה

      כל

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

    • targetOrigin

      מחרוזת

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

ContextMenuCreateProperties

Chrome 44 ואילך

מאפיינים

  • בוצע סימון

    ערך בוליאני אופציונלי

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

  • ההקשרים

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

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

  • documentUrlPatterns

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

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

  • פעיל

    ערך בוליאני אופציונלי

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

  • id [מזהה]

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

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • סוג

    ItemType אופציונלי

    הסוג של האפשרות בתפריט. ברירת המחדל היא 'רגיל'. אם הוא לא מוגדר.

  • onclick

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

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

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

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

    • מידע

      OnClickData

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

ContextMenus

Chrome 44 ואילך

מאפיינים

  • onShow

    אירוע<functioncancelcancel>

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

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

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

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

      פונקציה

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

      (event: object) => void

      • אירוע

        אובייקט

        • preventDefault

          ריק

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

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

          () => {...}

  • create

    ריק

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

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

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

    • createProperties

      אובייקט

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

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

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

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

      () => void

    • החזרות

      string | מספר טלפון

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

  • remove

    ריק

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

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

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

    • menuItemId

      string | מספר טלפון

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

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

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

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

      () => void

  • removeAll

    ריק

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

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

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

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

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

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

      () => void

  • עדכון

    ריק

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

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

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

    • id [מזהה]

      string | מספר טלפון

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

    • updateProperties

      אובייקט

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

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

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

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

      () => void

ContextMenuUpdateProperties

Chrome 44 ואילך

מאפיינים

  • בוצע סימון

    ערך בוליאני אופציונלי

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

  • ההקשרים

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

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

  • documentUrlPatterns

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

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

  • פעיל

    ערך בוליאני אופציונלי

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

  • parentId

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

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

  • targetUrlPatterns

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

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

  • title

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

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

  • סוג

    ItemType אופציונלי

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

  • onclick

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

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

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

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

    • מידע

      OnClickData

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

ContextType

Chrome 44 ואילך

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

Enum

"הכול"

"דף"

"מסגרת"

"בחירה"

"link"

"ניתן לעריכה"

"image"

"וידאו"

"audio"

DialogController

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

מאפיינים

  • ביטול

    ריק

    דוחים את תיבת הדו-שיח. זהה ללחיצה על 'ביטול' בתיבת דו-שיח של confirm או prompt.

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

    () => {...}

  • אישור

    ריק

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

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

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

    • תשובה

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

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

DownloadPermissionRequest

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

מאפיינים

  • requestMethod

    מחרוזת

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

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

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

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

    () => {...}

FileSystemPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

    דוחים את בקשת ההרשאה.

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

    () => {...}

FindCallbackResults

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

מאפיינים

  • activeMatchOrdinal

    number

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

  • בוטלו

    בוליאני

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

  • numberOfMatches

    number

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

  • selectionRect

    SelectionRect

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

FindOptions

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

מאפיינים

  • אחורה

    ערך בוליאני אופציונלי

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

  • matchCase

    ערך בוליאני אופציונלי

    סימון להתאמה עם החשיבות של אותיות רישיות (case-sensitive). ערך ברירת המחדל הוא false.

FullscreenPermissionRequest

Chrome 43 ואילך

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

מאפיינים

  • מקור

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

    דוחים את בקשת ההרשאה.

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

    () => {...}

GeolocationPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

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

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

    () => {...}

HidPermissionRequest

Chrome 125+

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

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

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

    () => {...}

InjectDetails

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

מאפיינים

  • קוד

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

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

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

  • קובץ

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

    JavaScript או קובץ CSS להחדרה.

InjectionItems

Chrome 44 ואילך

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

מאפיינים

  • קוד

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

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

  • קבצים

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

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

LoadPluginPermissionRequest

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

מאפיינים

  • מזהה

    מחרוזת

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

  • שם

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

    דוחים את בקשת ההרשאה.

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

    () => {...}

MediaPermissionRequest

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

מאפיינים

  • כתובת אתר

    מחרוזת

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

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

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

    () => {...}

NewWindow

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

מאפיינים

  • לחבר

    ריק

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

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

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

    • WebView

      אובייקט

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

  • מחיקה

    ריק

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

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

    () => {...}

PointerLockPermissionRequest

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

מאפיינים

  • lastUnlockedBySelf

    בוליאני

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

  • כתובת אתר

    מחרוזת

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

  • userGesture

    בוליאני

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

  • לאפשר

    ריק

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

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

    () => {...}

  • דחייה

    ריק

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

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

    () => {...}

SelectionRect

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

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

מאפיינים

  • גובה

    number

    גובה המלבן.

  • שמאלי

    number

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

  • עליון

    number

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

  • רוחב

    number

    רוחב המלבן.

WebRequestEventInterface

Chrome 44 ואילך

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

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

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

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

חשוב לשים לב שתנאים ופעולות עבור בקשות WebRequest הצהרתיות ב-webRequest צריכות להיווצר על ידי ה-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"
שינויי הזום יישמרו גם במקור של הדף המוגדל. כלומר, גם כל שאר רכיבי ה-WebView באותה מחיצה שמנווטים לאותו המקור יעברו שינוי מרחק התצוגה. בנוסף, per-origin שינויים בזום נשמרים עם המקור. כלומר, כשעוברים לדפים אחרים באותו מקור, השינוי בכולם יוגדל לאותו גורם זום.

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

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

מאפיינים

contentWindow

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

סוג

ContentWindow

contextMenus

Chrome 44 ואילך

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

סוג

ContextMenus

request

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

סוג

WebRequestEventInterface

שיטות

addContentScripts()

Chrome 44 ואילך 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

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

הדוגמה הבאה מוסיפה שני כללים למאפיין webview: 'myRule' ו-'otherRule'.

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)

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

    Chrome 44 ואילך

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

    (success: boolean) => void

    • הצלחה

      בוליאני

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

canGoBack()

chrome.webviewTag.canGoBack()

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

החזרות

  • בוליאני

canGoForward()

chrome.webviewTag.canGoForward()

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

החזרות

  • בוליאני

captureVisibleRegion()

Chrome 50+ 
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.

פרמטרים

  • אפשרויות

    ClearDataOptions

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

  • סוגים

    ClearDataTypeSet

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

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

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

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

    () => void

executeScript()

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

מחדיר קוד JavaScript לדף האורח.

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

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

פרמטרים

  • פרטים

    InjectDetails

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

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

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

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

    (result?: any[]) => void

    • תוצאה

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

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

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)

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

    Chrome 44 ואילך

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

      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 לדף האורח.

פרמטרים

  • פרטים

    InjectDetails

    פרטי שירות ה-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

    מחרוזת

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

  • virtualUrl

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

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

print()

chrome.webviewTag.print()

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

reload()

chrome.webviewTag.reload()

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

removeContentScripts()

Chrome 44 ואילך 
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,
)

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

פרמטרים

  • פעיל

    בוליאני

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

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

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

פרמטרים

  • userAgent

    מחרוזת

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

setZoom()

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

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

פרמטרים

  • zoomFactor

    number

    הגורם החדש לשינוי מרחק התצוגה.

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

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

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

    () => void

setZoomMode()

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

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

פרמטרים

  • ZoomMode

    ZoomMode

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

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

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

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

    () => void

stop()

chrome.webviewTag.stop()

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

stopFinding()

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

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

פרמטרים

  • פעולה

    "ניקוי"
     | "keep"
     | "הפעלה"
     אופציונלי

    המדיניות הזו קובעת מה לעשות עם ההתאמה הפעילה אחרי שסשן החיפוש הסתיים. 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

      'התראות'
       | "confirm" (אישור)
       | "הודעה"

    • messageText

      מחרוזת

    • תיבת דו-שיח

      DialogController

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

    • סיבה

      "רגיל"
       | "חריג"
       | "קריסה"
       | "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

      SelectionRect

    • בוטלו

      בוליאני

    • finalUpdate

      מחרוזת

loadabort

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

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

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

הערה:כאשר הטעינה של כתובת URL 'מידע כללי' או של כתובת 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"
       | &quot;ERR_INVALID_URL&quot;
       | &quot;ERR_DISALLOWED_URL_SCHEME&quot;
       | &quot;ERR_BLOCKED_BY_CLIENT&quot;
       | "ERR_ADDRESS_UNREACHABLE"
       | &quot;ERR_EMPTY_RESPONSE&quot;
       | &quot;ERR_FILE_NOT_FOUND&quot;
       | &quot;ERR_UNKNOWN_URL_SCHEME&quot;

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

מופעל כשכל הטעינה ברמת הפריים בדף אורח (כולל כל תתי-הפריים שלו) הושלמו. ההנחיה כוללת ניווט בתוך המסמך הנוכחי וגם טעינות ברמת המסמך המשני, אבל לא כוללת טעינות של משאבים אסינכרוניים. האירוע הזה מופעל בכל פעם שמספר הטעינות ברמת המסמך עובר מ-1 (או יותר) לאפס. לדוגמה, אם דף שכבר הסתיים להיטען (כלומר, 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: "ignore" 
          | "save_to_disk" 
          | "current_tab" 
          | "new_background_tab" 
          | "new_foreground_tab" 
          | "new_window" 
          | "new_popup" 
         ) => void

    • חלון

      NewWindow

    • targetUrl

      מחרוזת

    • initialWidth

      number

    • initialHeight

      number

    • שם

      מחרוזת

    • windowOpenDisposition

      "ignore"
       | "save_to_disk"
       | "current_tab"
       | &quot;new_background_tab&quot;
       | "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"
       | "הורדה"
       | "loadPlugin"
       | "filesystem"
       | "מסך מלא"
       | "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