chrome.webviewTag

Descripción

Usa la etiqueta webview para cargar contenido en vivo de la Web de forma activa a través de la red y, luego, incorporarlo en tu app de Chrome. Tu app puede controlar la apariencia de webview e interactuar con el contenido web, iniciar navegaciones en una página web incorporada, reaccionar a eventos de error que ocurren en ella y mucho más (consulta Uso).

Permisos

webview

Tipos

ClearDataOptions

Son opciones que determinan qué datos debe borrar clearData.

Propiedades

  • desde

    número opcional

    Datos claros acumulados a partir de esta fecha, representados en milisegundos desde el ciclo de entrenamiento (se puede acceder a ellos a través del método getTime del objeto Date de JavaScript) Si no está presente, el valor predeterminado es 0 (lo que quitaría todos los datos de navegación).

ClearDataTypeSet

Es un conjunto de tipos de datos. Las propiedades faltantes se interpretan como false.

Propiedades

  • appcache

    booleano opcional

    Los cachés de apps de los sitios web

  • Almacenamiento en caché

    booleano opcional

    Chrome 44 y versiones posteriores

    A partir de Chrome 43. La caché del navegador Nota: Cuando se quitan datos, se borra toda la caché, no se limita al rango que especificas.

  • cookies

    booleano opcional

    Las cookies de la partición

  • fileSystems

    booleano opcional

    Sistemas de archivos de sitios web

  • indexedDB

    booleano opcional

    Datos de IndexedDB de los sitios web

  • localStorage

    booleano opcional

    Datos de almacenamiento local de los sitios web

  • persistentCookies

    booleano opcional

    Chrome 58 y versiones posteriores

    Las cookies persistentes de la partición

  • sessionCookies

    booleano opcional

    Chrome 58 y versiones posteriores

    Las cookies de sesión de la partición

  • webSQL

    booleano opcional

    Datos de WebSQL de los sitios web

ContentScriptDetails

Chrome 44 y versiones posteriores

Detalles de la secuencia de comandos de contenido que se insertará. Consulta la documentación de las secuencias de comandos de contenido para obtener más detalles.

Propiedades

  • all_frames

    booleano opcional

    Si all_frames es true, esto implica que el código JavaScript o CSS se debe insertar en todos los marcos de la página actual. De forma predeterminada, all_frames es false y el código JavaScript o CSS solo se inserta en el marco superior.

  • css

    InjectionItems opcional

    El código CSS o una lista de archivos CSS que se insertarán en las páginas coincidentes. Se insertan en el orden en que aparecen, antes de que se construya o muestre ningún DOM para la página.

  • exclude_globs

    string[] opcional

    Se aplica después de las coincidencias para excluir las URLs que coincidan con este glob. Su objetivo es emular la palabra clave @exclude de Greasemonkey.

  • exclude_matches

    string[] opcional

    Excluye las páginas en las que, de otro modo, se insertaría esta secuencia de comandos de contenido.

  • include_globs

    string[] opcional

    Se aplica después de las coincidencias para incluir solo aquellas URLs que también coincidan con este glob. Su objetivo es emular la palabra clave @include de Greasemonkey.

  • js

    InjectionItems opcional

    El código JavaScript o una lista de archivos JavaScript que se insertarán en las páginas coincidentes. Se insertan en el orden en que aparecen.

  • match_about_blank

    booleano opcional

    Indica si se debe insertar la secuencia de comandos de contenido en about:blank y about:srcdoc. Las secuencias de comandos de contenido solo se insertarán en las páginas cuando su URL heredada coincida con uno de los patrones declarados en el campo de coincidencias. La URL heredada es la URL del documento que creó el marco o la ventana. Las secuencias de comandos de contenido no se pueden insertar en marcos de zona de pruebas.

  • coincide con

    string[]

    Especifica en qué páginas se insertará esta secuencia de comandos de contenido.

  • nombre

    string

    Es el nombre de la secuencia de comandos de contenido que se insertará.

  • run_at

    RunAt opcional

    La mayor brevedad con la que se insertará el código JavaScript o CSS en la pestaña. El valor predeterminado es "document_idle".

ContentWindow

Control de mensajería a una ventana de invitado.

Propiedades

  • postMessage

    void

    Publica un mensaje en el contenido web incorporado, siempre y cuando el contenido incorporado muestre una página del origen de destino. Este método está disponible una vez que se completa la carga de la página. Escucha el evento contentload y, luego, llama al método.

    El invitado podrá enviar respuestas al incorporador publicando un mensaje en event.source en el evento de mensaje que reciba.

    Esta API es idéntica a la API de postMessage de HTML5 para la comunicación entre páginas web. El incorporador puede escuchar las respuestas agregando un objeto de escucha de eventos message a su propio marco.

    La función postMessage se ve de la siguiente manera: 

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

    • mensaje

      cualquiera

      Es el objeto del mensaje que se enviará al invitado.

    • targetOrigin

      string

      Especifica cuál debe ser el origen de la ventana de invitado para que se envíe el evento.

ContextMenuCreateProperties

Chrome 44 y versiones posteriores

Propiedades

  • activado

    booleano opcional

    Es el estado inicial de una casilla de verificación o un elemento de selección: verdadero para seleccionado y falso para no seleccionado. Solo se puede seleccionar un elemento de selección a la vez en un grupo determinado de elementos de selección.

  • contextos

    [ContextType, ...ContextType[]] opcional

    Es la lista de contextos en los que aparecerá este elemento de menú. Si no se especifica, el valor predeterminado es ['page'].

  • documentUrlPatterns

    string[] opcional

    Te permite restringir el elemento para que se aplique solo a los documentos cuya URL coincida con uno de los patrones determinados. (Esto también se aplica a los marcos). Para obtener más información sobre el formato de un patrón, consulta Patrones de coincidencia.

  • habilitado

    booleano opcional

    Indica si este elemento del menú contextual está habilitado o inhabilitado. La configuración predeterminada es true.

  • id

    cadena opcional

    Es el ID único que se asignará a este artículo. Obligatorio para las páginas de eventos. No puede ser el mismo que otro ID para esta extensión.

  • parentId

    cadena | número opcional

    Es el ID de un elemento de menú superior, lo que hace que el elemento sea secundario de un elemento agregado anteriormente.

  • targetUrlPatterns

    string[] opcional

    Es similar a documentUrlPatterns, pero te permite filtrar en función del atributo src de las etiquetas img/audio/video y el href de las etiquetas de ancla.

  • título

    cadena opcional

    Es el texto que se mostrará en el elemento. Es obligatorio, a menos que type sea "separador". Cuando el contexto es "selection", puedes usar %s dentro de la cadena para mostrar el texto seleccionado. Por ejemplo, si el valor de este parámetro es "Traducir '%s' a Pig Latin" y el usuario selecciona la palabra "cool", el elemento del menú contextual para la selección es "Traducir 'cool' a Pig Latin".

  • tipo

    ItemType opcional

    Es el tipo de elemento de menú. Si no se especifica, el valor predeterminado es "normal".

  • onclick

    void optional

    Es una función a la que se llamará cuando se haga clic en el elemento de menú.

    La función onclick se ve de la siguiente manera: 

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

    • información

      OnClickData

      Información sobre el elemento en el que se hizo clic y el contexto en el que se produjo el clic.

ContextMenus

Chrome 44 y versiones posteriores

Propiedades

  • onShow

    Event<functionvoidvoid>

    Se activa antes de mostrar un menú contextual en este webview. Se puede usar para inhabilitar este menú contextual llamando a event.preventDefault().

    La función onShow.addListener se ve de la siguiente manera: 

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

    • callback

      función

      El parámetro callback se ve de la siguiente manera: 

      (event: object) => void

      • evento

        objeto

        • preventDefault

          void

          Llama a esta función para evitar que se muestre el menú contextual.

          La función preventDefault se ve de la siguiente manera: 

          () => {...}

  • create

    void

    Crea un nuevo elemento de menú contextual. Ten en cuenta que, si se produce un error durante la creación, es posible que no te enteres hasta que se active la devolución de llamada de creación (los detalles estarán en runtime.lastError).

    La función create se ve de la siguiente manera: 

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

    • createProperties

      objeto

      Las propiedades que se usan para crear el elemento

    • callback

      función opcional

      El parámetro callback se ve de la siguiente manera: 

      () => void

    • muestra

      cadena | número

      Es el ID del elemento recién creado.

  • quitar

    void

    Quita un elemento del menú contextual.

    La función remove se ve de la siguiente manera: 

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

    • menuItemId

      cadena | número

      Es el ID del elemento del menú contextual que se quitará.

    • callback

      función opcional

      El parámetro callback se ve de la siguiente manera: 

      () => void

  • removeAll

    void

    Quita todos los elementos del menú contextual que se hayan agregado a este webview.

    La función removeAll se ve de la siguiente manera: 

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

    • callback

      función opcional

      El parámetro callback se ve de la siguiente manera: 

      () => void

  • update

    void

    Actualiza un elemento de menú contextual creado con anterioridad.

    La función update se ve de la siguiente manera: 

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

    • id

      cadena | número

      Es el ID del artículo que se actualizará.

    • updateProperties

      objeto

      Las propiedades que se actualizarán. Acepta los mismos valores que la función create.

    • callback

      función opcional

      El parámetro callback se ve de la siguiente manera: 

      () => void

ContextMenuUpdateProperties

Chrome 44 y versiones posteriores

Propiedades

  • activado

    booleano opcional

    Es el estado de una casilla de verificación o un elemento de botón de selección: verdadero para seleccionado y falso para no seleccionado. Solo se puede seleccionar un elemento de selección a la vez en un grupo determinado de elementos de selección.

  • contextos

    [ContextType, ...ContextType[]] opcional

    Es la lista de contextos en los que aparecerá este elemento de menú.

  • documentUrlPatterns

    string[] opcional

    Te permite restringir el elemento para que se aplique solo a los documentos cuya URL coincida con uno de los patrones determinados. (Esto también se aplica a los marcos). Para obtener más información sobre el formato de un patrón, consulta Patrones de coincidencia.

  • habilitado

    booleano opcional

    Indica si este elemento del menú contextual está habilitado o inhabilitado.

  • parentId

    cadena | número opcional

    Es el ID de un elemento de menú superior, lo que hace que el elemento sea secundario de un elemento agregado anteriormente. Nota: No puedes cambiar un elemento para que sea secundario de uno de sus propios descendientes.

  • targetUrlPatterns

    string[] opcional

    Es similar a documentUrlPatterns, pero te permite filtrar en función del atributo src de las etiquetas img/audio/video y el href de las etiquetas de ancla.

  • título

    cadena opcional

    Es el texto que se mostrará en el elemento.

  • tipo

    ItemType opcional

    Es el tipo de elemento de menú.

  • onclick

    void optional

    Es una función a la que se llamará cuando se haga clic en el elemento de menú.

    La función onclick se ve de la siguiente manera: 

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

    • información

      OnClickData

      Información sobre el elemento en el que se hizo clic y el contexto en el que se produjo el clic.

ContextType

Chrome 44 y versiones posteriores

Los diferentes contextos en los que puede aparecer un menú. Especificar "todos" equivale a la combinación de todos los demás contextos.

Enum

"all"

"page"

"frame"

"selection"

"link"

"editable"

"image"

"video"

"audio"

DialogController

Interfaz adjunta a los eventos del DOM dialog.

Propiedades

  • cancelar

    void

    Rechaza el diálogo. Equivale a hacer clic en Cancelar en un diálogo confirm o prompt.

    La función cancel se ve de la siguiente manera: 

    () => {...}

  • Aceptar

    void

    Acepta el diálogo. Es equivalente a hacer clic en Aceptar en un cuadro de diálogo alert, confirm o prompt.

    La función ok se ve de la siguiente manera: 

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

    • respuesta

      cadena opcional

      Es la cadena de respuesta que se le debe proporcionar al invitado cuando acepta un diálogo prompt.

DownloadPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM download permissionrequest.

Propiedades

  • requestMethod

    string

    Es el tipo de solicitud HTTP (p.ej., GET) asociado con la solicitud de descarga.

  • url

    string

    Es la URL de descarga solicitada.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a allow.

    La función deny se ve de la siguiente manera: 

    () => {...}

FileSystemPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM filesystem permissionrequest.

Propiedades

  • url

    string

    Es la URL del marco que solicita acceso al sistema de archivos local.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso.

    La función deny se ve de la siguiente manera: 

    () => {...}

FindCallbackResults

Contiene todos los resultados de la solicitud de búsqueda.

Propiedades

  • activeMatchOrdinal

    número

    Es el número ordinal de la coincidencia actual.

  • cancelado

    booleano

    Indica si se canceló esta solicitud de búsqueda.

  • numberOfMatches

    número

    Es la cantidad de veces que searchText coincidió en la página.

  • selectionRect

    SelectionRect

    Describe un rectángulo alrededor de la coincidencia activa en coordenadas de pantalla.

FindOptions

Son opciones para la solicitud de búsqueda.

Propiedades

  • hacia atrás

    booleano opcional

    Marca para encontrar coincidencias en orden inverso. El valor predeterminado es false.

  • matchCase

    booleano opcional

    Marca para que coincida con la distinción entre mayúsculas y minúsculas. El valor predeterminado es false.

FullscreenPermissionRequest

Chrome 43 y versiones posteriores

Es el tipo de objeto request que acompaña a un evento DOM fullscreen permissionrequest.

Propiedades

  • origin

    string

    Es el origen del fotograma dentro del webview que inició la solicitud de pantalla completa.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso.

    La función deny se ve de la siguiente manera: 

    () => {...}

GeolocationPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM geolocation permissionrequest.

Propiedades

  • url

    string

    Es la URL del marco que solicita acceso a los datos de ubicación geográfica.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a allow.

    La función deny se ve de la siguiente manera: 

    () => {...}

HidPermissionRequest

Chrome 125 y versiones posteriores

Es el tipo de objeto request que acompaña a un evento DOM hid permissionrequest.

Propiedades

  • url

    string

    Es la URL de la trama que solicita acceso a la API de HID.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a allow.

    La función deny se ve de la siguiente manera: 

    () => {...}

InjectDetails

Detalles de la secuencia de comandos o el CSS que se insertará. Se debe configurar el código o la propiedad del archivo, pero no ambos al mismo tiempo.

Propiedades

  • código

    cadena opcional

    Código JavaScript o CSS para insertar.

    Advertencia: Ten cuidado cuando uses el parámetro code. Si se usa de forma incorrecta, es posible que tu app esté expuesta a ataques de secuencia de comandos entre sitios.

  • archivo

    cadena opcional

    Es el archivo JavaScript o CSS que se insertará.

InjectionItems

Chrome 44 y versiones posteriores

El tipo de elemento de inserción: código o un conjunto de archivos.

Propiedades

  • código

    cadena opcional

    Código JavaScript o CSS que se insertará en las páginas coincidentes.

  • archivos

    string[] opcional

    Es la lista de archivos JavaScript o CSS que se insertarán en las páginas coincidentes. Se insertan en el orden en que aparecen en este array.

LoadPluginPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM loadplugin permissionrequest.

Propiedades

  • identificador

    string

    Es la cadena de identificador del complemento.

  • nombre

    string

    Es el nombre visible del complemento.

  • allow

    void

    Permite la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a deny.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso.

    La función deny se ve de la siguiente manera: 

    () => {...}

MediaPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM media permissionrequest.

Propiedades

  • url

    string

    Es la URL del marco que solicita acceso al contenido multimedia del usuario.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a allow.

    La función deny se ve de la siguiente manera: 

    () => {...}

NewWindow

Interfaz adjunta a los eventos del DOM newwindow.

Propiedades

  • adjuntar

    void

    Adjunta la página de destino solicitada a un elemento webview existente.

    La función attach se ve de la siguiente manera: 

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

    • WebView

      objeto

      Es el elemento webview al que se debe adjuntar la página de destino.

  • descartar

    void

    Cancela la solicitud de ventana nueva.

    La función discard se ve de la siguiente manera: 

    () => {...}

PointerLockPermissionRequest

Es el tipo de objeto request que acompaña a un evento DOM pointerLock permissionrequest.

Propiedades

  • lastUnlockedBySelf

    booleano

    Indica si el fotograma solicitante fue el cliente más reciente que mantuvo el bloqueo del puntero.

  • url

    string

    Es la URL del marco que solicita el bloqueo del puntero.

  • userGesture

    booleano

    Indica si se solicitó o no el bloqueo del puntero como resultado de un gesto de entrada del usuario.

  • allow

    void

    Permite la solicitud de permiso.

    La función allow se ve de la siguiente manera: 

    () => {...}

  • deny

    void

    Rechaza la solicitud de permiso. Este es el comportamiento predeterminado si no se llama a allow.

    La función deny se ve de la siguiente manera: 

    () => {...}

SelectionRect

Describe un rectángulo en coordenadas de pantalla.

La semántica de contención es similar a la de un array; es decir, se considera que el rectángulo contiene la coordenada (left, top), pero no la coordenada (left + width, top).

Propiedades

  • alto

    número

    Es la altura del rectángulo.

  • izquierda

    número

    Es la distancia desde el borde izquierdo de la pantalla hasta el borde izquierdo del rectángulo.

  • superior

    número

    Es la distancia desde el borde superior de la pantalla hasta el borde superior del rectángulo.

  • ancho

    número

    Ancho del rectángulo.

WebRequestEventInterface

Chrome 44 y versiones posteriores

Es una interfaz que proporciona acceso a los eventos webRequest en la página de invitados. Consulta la API de extensiones chrome.webRequest para obtener detalles sobre el ciclo de vida de webRequest y los conceptos relacionados. Nota: El evento chrome.webRequest.onActionIgnored no es compatible con los objetos Webview.

Para ilustrar cómo difiere el uso de la API de webRequest de extensiones, considera el siguiente código de ejemplo que bloquea cualquier solicitud de invitado para URLs que coincidan con *://www.evil.com/*:

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

Además, esta interfaz admite reglas webRequest declarativas a través de eventos onRequest y onMessage. Consulta declarativeWebRequest para obtener detalles sobre la API.

Ten en cuenta que las condiciones y acciones para las solicitudes web de WebView declarativas deben crear instancias desde sus contrapartes de chrome.webViewRequest.*. En el siguiente ejemplo de código, se bloquean de forma declarativa todas las solicitudes a "example.com" en el myWebview de WebView:

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

ZoomMode

Chrome 43 y versiones posteriores

Define cómo se controla el zoom en webview.

Enum

"Por origen"
Los cambios de zoom persistirán en el origen de la página en la que se hizo zoom, es decir, también se aplicará el zoom a todas las otras vistas web de la misma partición a las que se navegue en ese mismo origen. Además, los cambios de zoom de per-origin se guardan con el origen, lo que significa que, cuando navegues a otras páginas en el mismo origen, todas tendrán el mismo factor de zoom.

"por vista"
Los cambios de zoom solo se aplican en este WebView, y los cambios de zoom en otros WebViews no afectarán el zoom de este WebView. Además, los cambios de zoom de per-view se restablecen durante la navegación. Navegar por un WebView siempre cargará páginas con sus factores de zoom por origen (dentro del alcance de la partición).

"disabled"
Inhabilita todo el zoom en el WebView. El contenido volverá al nivel de zoom predeterminado y se ignorarán todos los intentos de cambiar el zoom.

Propiedades

contentWindow

Es una referencia de objeto que se puede usar para publicar mensajes en la página de invitados.

Tipo

ContentWindow

contextMenus

Chrome 44 y versiones posteriores

Es similar a la API de ContextMenus de Chrome, pero se aplica a webview en lugar del navegador. Usa la API de webview.contextMenus para agregar elementos al menú contextual de webview. Puedes elegir a qué tipos de objetos se aplican las opciones que agregues al menú contextual, como imágenes, hipervínculos y páginas.

Tipo

ContextMenus

request

Es una interfaz que proporciona acceso a los eventos webRequest en la página de invitados.

Tipo

WebRequestEventInterface

Métodos

addContentScripts()

Chrome 44 y versiones posteriores 
chrome.webviewTag.addContentScripts(
  contentScriptList: [ContentScriptDetails, ...ContentScriptDetails[]],
)

Agrega reglas de inserción de secuencias de comandos de contenido a webview. Cuando webview navegue a una página que coincida con una o más reglas, se insertarán las secuencias de comandos asociadas. Puedes agregar reglas de forma programática o actualizar las existentes.

En el siguiente ejemplo, se agregan dos reglas a webview: "myRule" y "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';

Puedes aplazar la llamada a addContentScripts hasta que necesites insertar secuencias de comandos.

En el siguiente ejemplo, se muestra cómo reemplazar una regla existente.

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'}]);

Si webview navegó al origen (p.ej., foo.com) y llama a webview.addContentScripts para agregar "myRule", debes esperar a la siguiente navegación para que se inyecten las secuencias de comandos. Si quieres una inserción inmediata, executeScript hará lo correcto.

Las reglas se conservan incluso si el proceso invitado falla o se finaliza, o incluso si se vuelve a establecer el elemento superior de webview.

Consulta la documentación de las secuencias de comandos de contenido para obtener más detalles.

Parámetros

back()

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

Si es posible, navega hacia atrás una entrada del historial. Equivale a go(-1).

Parámetros

  • callback

    función opcional

    Chrome 44 y versiones posteriores

    El parámetro callback se ve de la siguiente manera: 

    (success: boolean) => void

    • correcto

      booleano

      Indica si la navegación se realizó correctamente.

canGoBack()

chrome.webviewTag.canGoBack()

Indica si es posible navegar hacia atrás por el historial. El estado de esta función se almacena en caché y se actualiza antes de cada loadcommit, por lo que el mejor lugar para llamarla es en loadcommit.

Muestra

  • booleano

canGoForward()

chrome.webviewTag.canGoForward()

Indica si es posible navegar hacia adelante por el historial. El estado de esta función se almacena en caché y se actualiza antes de cada loadcommit, por lo que el mejor lugar para llamarla es en loadcommit.

Muestra

  • booleano

captureVisibleRegion()

Chrome 50 o versiones posteriores 
chrome.webviewTag.captureVisibleRegion(
  options?: ImageDetails,
  callback: function,
)

Captura la región visible de la vista web.

Parámetros

  • opciones

    ImageDetails opcional

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (dataUrl: string) => void

    • dataUrl

      string

      Es una URL de datos que codifica una imagen del área visible de la pestaña capturada. Se puede asignar a la propiedad "src" de un elemento de imagen HTML para su visualización.

clearData()

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

Borra los datos de navegación de la partición webview.

Parámetros

  • opciones

    ClearDataOptions

    Son opciones que determinan qué datos se borrarán.

  • Los tipos de datos que se borrarán.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

executeScript()

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

Inserta código JavaScript en la página para invitados.

En el siguiente código de muestra, se usa la inserción de secuencias de comandos para establecer el color de fondo de la página para invitados en rojo:

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

Parámetros

  • detalles

    InjectDetails

    Detalles de la secuencia de comandos que se ejecutará.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result?: any[]) => void

    • resultado

      any[] opcional

      El resultado de la secuencia de comandos en cada fotograma insertado.

find()

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

Inicia una solicitud de búsqueda en la página.

Parámetros

  • searchText

    string

    Es la cadena que se debe encontrar en la página.

  • opciones

    FindOptions opcional

    Son opciones para la solicitud de búsqueda.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (results?: FindCallbackResults) => void

    • resultados

      FindCallbackResults opcional

      Contiene todos los resultados de la solicitud de búsqueda. Se puede omitir results si no se usa en el cuerpo de la función de devolución de llamada; por ejemplo, si la devolución de llamada solo se usa para discernir cuándo se completó la solicitud de búsqueda.

forward()

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

Navega hacia delante una entrada del historial si es posible. Equivale a go(1).

Parámetros

  • callback

    función opcional

    Chrome 44 y versiones posteriores

    El parámetro callback se ve de la siguiente manera: 

    (success: boolean) => void

    • correcto

      booleano

      Indica si la navegación se realizó correctamente.

getAudioState()

Chrome 62 y versiones posteriores 
chrome.webviewTag.getAudioState(
  callback: function,
)

Consulta el estado del audio.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (audible: boolean) => void

    • Audible

      booleano

getProcessId()

chrome.webviewTag.getProcessId()

Muestra el ID de proceso interno de Chrome para el proceso actual de la página web de invitado, lo que permite que los incorporadores sepan a cuántos invitados afectaría la finalización del proceso. Dos invitados compartirán un proceso solo si pertenecen a la misma app y tienen el mismo ID de partición de almacenamiento. La llamada es síncrona y muestra la noción almacenada en caché del ID de proceso actual del incorporador. El ID de proceso no es el mismo que el ID de proceso del sistema operativo.

Muestra

  • número

getUserAgent()

chrome.webviewTag.getUserAgent()

Muestra la cadena de usuario-agente que usa webview para las solicitudes de páginas de invitados.

Muestra

  • string

getZoom()

chrome.webviewTag.getZoom(
  callback: function,
)

Obtiene el factor de zoom actual.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (zoomFactor: number) => void

    • zoomFactor

      número

      Es el factor de zoom actual.

getZoomMode()

Chrome 43 y versiones posteriores 
chrome.webviewTag.getZoomMode(
  callback: function,
)

Obtiene el modo de zoom actual.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (ZoomMode: ZoomMode) => void

    • ZoomMode

      ZoomMode

      Es el modo de zoom actual de webview.

go()

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

Navega a una entrada de historial con un índice de historial en relación con la navegación actual. Si la navegación solicitada es imposible, este método no tiene efecto.

Parámetros

  • relativeIndex

    número

    Es el índice de historial relativo al que se debe navegar en webview. Por ejemplo, un valor de 2 navegará hacia adelante 2 entradas de historial si es posible; un valor de -3 navegará hacia atrás 3 entradas.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (success: boolean) => void

    • correcto

      booleano

      Indica si la navegación se realizó correctamente.

insertCSS()

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

Inserta CSS en la página de invitados.

Parámetros

  • detalles

    InjectDetails

    Detalles del CSS que se insertará.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

isAudioMuted()

Chrome 62 y versiones posteriores 
chrome.webviewTag.isAudioMuted(
  callback: function,
)

Consulta si el audio está silenciado.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (muted: boolean) => void

    • silenciado

      booleano

isSpatialNavigationEnabled()

Chrome 71 y versiones posteriores 
chrome.webviewTag.isSpatialNavigationEnabled(
  callback: function,
)

Consulta si la navegación espacial está habilitada para la vista web.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (enabled: boolean) => void

    • habilitado

      booleano

isUserAgentOverridden()

chrome.webviewTag.isUserAgentOverridden()

Indica si webviewTag.setUserAgentOverride anuló o no la cadena del usuario-agente de webview.

loadDataWithBaseUrl()

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

Carga una URL de datos con una URL base especificada que se usa para los vínculos relativos. De forma opcional, se puede proporcionar una URL virtual para que se muestre al usuario en lugar de la URL de datos.

Parámetros

  • dataUrl

    string

    Es la URL de los datos que se cargarán.

  • baseUrl

    string

    La URL base que se usará para los vínculos relativos.

  • virtualUrl

    cadena opcional

    Es la URL que se mostrará al usuario (en la barra de direcciones).

print()

chrome.webviewTag.print()

Imprime el contenido de webview. Esto equivale a llamar a la función de impresión de secuencias de comandos desde el webview.

reload()

chrome.webviewTag.reload()

Vuelve a cargar la página de nivel superior actual.

removeContentScripts()

Chrome 44 y versiones posteriores 
chrome.webviewTag.removeContentScripts(
  scriptNameList?: string[],
)

Quita las secuencias de comandos del contenido de un webview.

En el siguiente ejemplo, se quita "myRule", que se agregó antes.

webview.removeContentScripts(['myRule']);

Para quitar todas las reglas, llama a lo siguiente:

webview.removeContentScripts();

Parámetros

  • scriptNameList

    string[] opcional

    Es una lista de nombres de secuencias de comandos de contenido que se quitarán. Si la lista está vacía, se quitarán todas las secuencias de comandos del contenido agregadas a webview.

setAudioMuted()

Chrome 62 y versiones posteriores 
chrome.webviewTag.setAudioMuted(
  mute: boolean,
)

Establece el estado de silenciamiento de audio de la vista web.

Parámetros

  • silenciar

    booleano

    Valor de silenciamiento de audio

setSpatialNavigationEnabled()

Chrome 71 y versiones posteriores 
chrome.webviewTag.setSpatialNavigationEnabled(
  enabled: boolean,
)

Establece el estado de navegación espacial de la vista web.

Parámetros

  • habilitado

    booleano

    Valor del estado de navegación espacial.

setUserAgentOverride()

chrome.webviewTag.setUserAgentOverride(
  userAgent: string,
)

Anula la cadena de usuario-agente que usa webview para las solicitudes de páginas de invitados. La anulación hará que los valores del encabezado User-Agent Client Hint y los valores que muestra navigator.userAgentData estén vacíos para las solicitudes de páginas de invitados a las que se aplica esta anulación.

Parámetros

  • userAgent

    string

    Es la cadena de usuario-agente que se usará.

setZoom()

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

Cambia el factor de zoom de la página. El alcance y la persistencia de este cambio se determinan según el modo de zoom actual del WebView (consulta webviewTag.ZoomMode).

Parámetros

  • zoomFactor

    número

    Es el nuevo factor de zoom.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

setZoomMode()

Chrome 43 y versiones posteriores 
chrome.webviewTag.setZoomMode(
  ZoomMode: ZoomMode,
  callback?: function,
)

Establece el modo de zoom de webview.

Parámetros

  • ZoomMode

    ZoomMode

    Define cómo se controla el zoom en webview.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

stop()

chrome.webviewTag.stop()

Detiene la carga de la navegación webview actual si está en curso.

stopFinding()

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

Finaliza la sesión de búsqueda actual (borra todos los elementos destacados) y cancela todas las solicitudes de búsqueda en curso.

Parámetros

  • acción

    "clear"
     | "keep"
     | "activate"
     opcional

    Determina qué hacer con la coincidencia activa después de que finaliza la sesión de búsqueda. clear borrará el resaltado de la coincidencia activa; keep mantendrá la coincidencia activa destacada; activate mantendrá la coincidencia activa destacada y simulará que un usuario hace clic en esa coincidencia. La acción predeterminada es keep.

terminate()

chrome.webviewTag.terminate()

Cancela de forma forzosa el proceso de renderización de la página web para invitados. Esto puede afectar a varias etiquetas webview en la app actual si comparten el mismo proceso, pero no afectará a las etiquetas webview en otras apps.

Eventos

close

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

Se activa cuando la ventana de invitado intenta cerrarse.

En el siguiente código de ejemplo, se navega de webview a about:blank cuando el invitado intenta cerrarse.

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    () => void

consolemessage

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

Se activa cuando la ventana de invitado registra un mensaje de la consola.

En el siguiente ejemplo de código, se reenvían todos los mensajes de registro a la consola del incorporador sin tener en cuenta el nivel de registro ni otras propiedades.

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • level

      número

    • mensaje

      string

    • línea

      número

    • sourceId

      string

contentload

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

Se activa cuando la ventana de invitado activa un evento load, es decir, cuando se carga un documento nuevo. Esto no incluye la navegación de páginas dentro del documento actual ni las cargas de recursos asíncronos.

En el siguiente ejemplo de código, se modifica el tamaño de fuente predeterminado del elemento body del invitado después de que se carga la página:

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    () => void

dialog

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

Se activa cuando la ventana del invitado intenta abrir un diálogo modal a través de window.alert, window.confirm o window.prompt.

Si controlas este evento, se bloqueará el proceso de invitado hasta que se devuelva cada objeto de escucha de eventos o hasta que el objeto dialog no se pueda alcanzar (si se llamó a preventDefault()).

El comportamiento predeterminado es cancelar el diálogo.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • messageType

      "alert"
       | "confirm"
       | "prompt"

    • messageText

      string

    • diálogo

      DialogController

exit

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

Se activa cuando finaliza el proceso de renderización del contenido web del invitado.

El siguiente código de ejemplo mostrará un mensaje de despedida cada vez que falle la página para invitados:

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • processID

      número

    • Reason

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

findupdate

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

Se activa cuando hay resultados de búsqueda nuevos disponibles para una solicitud de búsqueda activa. Esto puede suceder varias veces para una sola solicitud de búsqueda a medida que se encuentran coincidencias.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • searchText

      string

    • numberOfMatches

      número

    • activeMatchOrdinal

      número

    • selectionRect

      SelectionRect

    • cancelado

      booleano

    • finalUpdate

      string

loadabort

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

Se activa cuando se aborta una carga de nivel superior sin confirmarse. Se imprimirá un mensaje de error en la consola, a menos que se evite el evento de forma predeterminada.

Nota: Cuando se aborta una carga de recursos, un evento loadabort eventualmente será seguido por un evento loadstop, incluso si se abortaron todas las cargas confirmadas desde el último evento loadstop (si lo hubiera).

Nota: Cuando se cancele la carga de una URL de información o de una URL de JavaScript, se activará loadabort y, luego, se navegará a webview en "about:blank".

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (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

    • url

      string

    • isTopLevel

      booleano

    • código

      número

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

loadcommit

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

Se activa cuando se confirma una carga. Esto incluye la navegación dentro del documento actual, así como las cargas a nivel del documento del submarco, pero no incluye las cargas de recursos asíncronos.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • url

      string

    • isTopLevel

      booleano

loadredirect

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

Se activa cuando una solicitud de carga de nivel superior redirecciona a una URL diferente.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • oldUrl

      string

    • newUrl

      string

    • isTopLevel

      booleano

loadstart

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

Se activa cuando comienza una carga.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • url

      string

    • isTopLevel

      booleano

loadstop

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

Se activa cuando se completan todas las cargas a nivel del marco en una página de invitado (incluidos todos sus submarcos). Esto incluye la navegación dentro del documento actual, así como las cargas a nivel del documento del submarco, pero no incluye las cargas de recursos asíncronos. Este evento se activa cada vez que la cantidad de cargas a nivel del documento pasa de uno (o más) a cero. Por ejemplo, si una página que ya terminó de cargarse (es decir, loadstop ya se activó una vez) crea un iframe nuevo que carga una página. Luego, se activará un segundo loadstop cuando se complete la carga de la página del iframe. Este patrón se observa con frecuencia en las páginas que cargan anuncios.

Nota: Cuando se aborta una carga confirmada, un evento loadstop seguirá a un evento loadabort, incluso si se abortaron todas las cargas confirmadas desde el último evento loadstop (si lo hubiera).

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    () => void

newwindow

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

Se activa cuando la página para invitados intenta abrir una ventana nueva del navegador.

En el siguiente ejemplo de código, se creará y navegará a un nuevo webview en el incorporador para cada ventana nueva solicitada:

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (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

    • ventana

      NewWindow

    • targetUrl

      string

    • initialWidth

      número

    • initialHeight

      número

    • nombre

      string

    • windowOpenDisposition

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

permissionrequest

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

Se activa cuando la página para invitados necesita solicitar un permiso especial al incorporador.

El siguiente código de ejemplo otorgará a la página de invitado acceso a la API de webkitGetUserMedia. Ten en cuenta que una app que use este código de ejemplo debe especificar los permisos de manifiesto audioCapture o videoCapture:

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (permission: "media" 
      | "geolocation" 
      | "pointerLock" 
      | "download" 
      | "loadplugin" 
      | "filesystem" 
      | "fullscreen" 
      | "hid" 
     , request: object) => void

    • permiso

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

    • request

      objeto

responsive

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

Se activa cuando el proceso que renderiza el contenido web del invitado vuelve a responder después de no hacerlo.

En el siguiente ejemplo de código, se atenuará o se ocultará el elemento webview a medida que se vuelva responsivo o no responsivo:

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

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (processID: number) => void

    • processID

      número

sizechanged

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

Se activa cuando se cambia el tamaño del contenido web incorporado a través de autosize. Solo se activa si autosize está habilitado.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • oldWidth

      número

    • oldHeight

      número

    • newWidth

      número

    • newHeight

      número

unresponsive

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

Se activa cuando el proceso que renderiza el contenido web invitado deja de responder. Este evento se generará una vez con un evento responsivo coincidente si el invitado vuelve a responder.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (processID: number) => void

    • processID

      número

zoomchange

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

Se activa cuando cambia el zoom de la página.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • oldZoomFactor

      número

    • newZoomFactor

      número