chrome.extension

Descripción

La API de chrome.extension tiene utilidades que puede usar cualquier página de extensión. Incluye compatibilidad para intercambiar mensajes entre una extensión y sus secuencias de comandos de contenido o entre extensiones, como se describe en detalle en Envío de mensajes.

Tipos

ViewType

Chrome 44 y versiones posteriores

Es el tipo de vista de extensión.

Enum

Propiedades

inIncognitoContext

Esto es válido para las secuencias de comandos de contenido que se ejecutan en pestañas de incógnito y para las páginas de extensiones que se ejecutan en un proceso de incógnito. Esta última solo se aplica a las extensiones con comportamiento incógnito "dividido".

Tipo

boolean

lastError

≤ MV2 Obsoleta a partir de Chrome 58

Usa runtime.lastError.

Se establece durante el ciclo de vida de una devolución de llamada si una API de extensión asíncrona generó un error. Si no se produjo ningún error, lastError será undefined.

Tipo

objeto

Propiedades

  • message

    cadena

    Descripción del error ocurrido.

Métodos

getBackgroundPage()

Solo en primer plano 
chrome.extension.getBackgroundPage()

Muestra el objeto "window" de JavaScript para la página en segundo plano que se ejecuta dentro de la extensión actual. Muestra un valor nulo si la extensión no tiene una página en segundo plano.

Devuelve

  • Ventana|no definida

getExtensionTabs()

≤ MV2 Solo en primer plano Obsoleto
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Usa extension.getViews {type: "tab"}.

Devuelve una matriz de los objetos "window" de JavaScript para cada una de las pestañas que se ejecutan dentro de la extensión actual. Si se especifica windowId, solo muestra los objetos "window" de las pestañas adjuntas a la ventana especificada.

Parámetros

  • windowId

    número opcional

Devuelve

  • Ventana

    Array de objetos de ventana global

getURL()

≤ MV2 Obsoleta a partir de Chrome 58
chrome.extension.getURL(
  path: string,
)

Usa runtime.getURL.

Convierte una ruta de acceso relativa dentro de un directorio de instalación de una extensión en una URL completamente calificada.

Parámetros

  • ruta de acceso

    cadena

    Una ruta de acceso a un recurso dentro de una extensión expresada en relación con su directorio de instalación.

Devuelve

  • cadena

    Es la URL completamente calificada al recurso.

getViews()

Solo en primer plano 
chrome.extension.getViews(
  fetchProperties?: object,
)

Devuelve una matriz de los objetos "window" de JavaScript para cada una de las páginas que se ejecutan dentro de la extensión actual.

Parámetros

  • fetchProperties

    objeto opcional

    • tabId

      número opcional

      Chrome 54 y versiones posteriores

      Busca una vista según un ID de pestaña. Si se omite este campo, muestra todas las vistas.

    • tipo

      ViewType opcional

      El tipo de vista que se obtendrá. Si se omite, muestra todas las vistas (incluidas las páginas y pestañas en segundo plano).

    • windowId

      número opcional

      Ventana a la que se restringirá la búsqueda. Si se omite, muestra todas las vistas.

Devuelve

  • Ventana

    Array de objetos globales

isAllowedFileSchemeAccess()

Promesa 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Recupera el estado de acceso de la extensión al esquema “file://”. Esto corresponde al parámetro de configuración por extensión "Permitir el acceso a las URLs del archivo" controlado por el usuario, al que se puede acceder mediante la página chrome://extensions.

Parámetros

  • callback

    Función opcional

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      Es verdadero si la extensión puede acceder al esquema 'file://'. De lo contrario, es falso.

Devuelve

  • Promise<boolean>

    Chrome 99 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

isAllowedIncognitoAccess()

Promesa 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Recupera el estado de acceso de la extensión al modo Incógnito. Corresponde al parámetro de configuración "Permitido en Incógnito" controlado por el usuario, al que se puede acceder mediante la página chrome://extensions.

Parámetros

  • callback

    Función opcional

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

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      Verdadero si la extensión tiene acceso al modo Incógnito; de lo contrario, es falso.

Devuelve

  • Promise<boolean>

    Chrome 99 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

sendRequest()

Promise &leq; MV2 Obsoleto
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Usa runtime.sendMessage.

Envía una sola solicitud a otros objetos de escucha dentro de la extensión. Es similar a runtime.connect, pero solo envía una única solicitud con una respuesta opcional. Se activa el evento extension.onRequest en cada página de la extensión.

Parámetros

  • extensionId

    cadena opcional

    El ID de la extensión a la que deseas conectarte. Si se omite, el valor predeterminado será tu propia extensión.

  • request

    cualquiera

  • callback

    Función opcional

    Chrome 99 y versiones posteriores

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

    (response: any)=>void

    • respuesta

      cualquiera

      Objeto de respuesta JSON enviado por el controlador de la solicitud. Si se produce un error durante la conexión a la extensión, se llamará a la devolución de llamada sin argumentos y se establecerá runtime.lastError en el mensaje de error.

Devuelve

  • Promesa<cualquiera>

    Chrome 99 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Establece el valor del parámetro ap CGI que se usa en la URL de actualización de la extensión. Este valor se ignora para las extensiones alojadas en la Galería de extensiones de Chrome.

Parámetros

  • datos

    cadena

Eventos

onRequest

&leq; MV2 Obsoleto
chrome.extension.onRequest.addListener(
  callback: function,
)

Usa runtime.onMessage.

Se activa cuando se envía una solicitud desde un proceso de extensión o una secuencia de comandos de contenido.

Parámetros

  • callback

    la función

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

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • request

      cualquiera

    • sendResponse

      la función

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

      ()=>void

onRequestExternal

&leq; MV2 Obsoleto
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Usa runtime.onMessageExternal.

Se activa cuando se envía una solicitud desde otra extensión.

Parámetros

  • callback

    la función

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

    (request: any,sender: runtime.MessageSender,sendResponse: function)=>void

    • request

      cualquiera

    • sendResponse

      la función

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

      ()=>void