chrome.extension

Descripción

La API de chrome.extension tiene utilidades que pueden usar todas las páginas 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 Paso de mensajes.

Tipos

ViewType

Chrome 44 y versiones posteriores

Es el tipo de vista de extensión.

Enum

"tab"

"popup"

Propiedades

inIncognitoContext

Es verdadero para las secuencias de comandos de contenido que se ejecutan dentro de las pestañas de incógnito y para las páginas de extensión que se ejecutan dentro de un proceso de incógnito. Esta última solo se aplica a las extensiones con incognito_behavior "split".

Tipo

booleano

lastError

≤ MV2 Obsoleto desde Chrome 58

Usa runtime.lastError.

Se establece para la duración 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

  • mensaje

    string

    Es la descripción del error que se produjo.

Métodos

getBackgroundPage()

Solo en primer plano 
chrome.extension.getBackgroundPage(): Window | undefined

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

Muestra

  • Window | undefined

getExtensionTabs()

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

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

Devuelve un array 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 se devuelven los objetos "window" de las pestañas adjuntas a la ventana especificada.

Parámetros

  • windowId

    número opcional

Muestra

  • Window[]

    Es un array de objetos window globales.

getURL()

≤ MV2 Obsoleto desde Chrome 58
chrome.extension.getURL(
  path: string,
): string

Usa runtime.getURL.

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

Parámetros

  • ruta de acceso

    string

    Es una ruta de acceso a un recurso dentro de una extensión, expresada de forma relativa a su directorio de instalación.

Muestra

  • string

    Es la URL completamente calificada del recurso.

getViews()

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

Devuelve un array 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 el ID de una pestaña. Si se omite este campo, se devuelven todas las vistas.

    • tipo

      ViewType opcional

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

    • windowId

      número opcional

      Es la ventana en la que se restringirá la búsqueda. Si se omite, se muestran todas las vistas.

Muestra

  • Window[]

    Es un array de objetos globales.

isAllowedFileSchemeAccess()

Promesa 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

Recupera el estado del acceso de la extensión al esquema "file://". Esto corresponde al parámetro de configuración por extensión controlado por el usuario "Permitir acceso a URLs de archivos", al que se puede acceder a través de 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

      booleano

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

Muestra

  • Promise<boolean>

    Chrome 99 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

isAllowedIncognitoAccess()

Promesa 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

Recupera el estado del acceso de la extensión al modo Incógnito. Esto corresponde al parámetro de configuración "Permitir en Incógnito" por extensión controlado por el usuario al que se puede acceder a través de 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

      booleano

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

Muestra

  • Promise<boolean>

    Chrome 99 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

sendRequest()

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

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 solicitud con una respuesta opcional. El evento extension.onRequest se activa en cada página de la extensión.

Parámetros

  • extensionId

    cadena opcional

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

  • solicitud

    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

      Es el objeto de respuesta JSON que envía el controlador de la solicitud. Si se produce un error al conectarse a la extensión, se llamará a la devolución de llamada sin argumentos y runtime.lastError se establecerá en el mensaje de error.

Muestra

  • Promise<any>

    Chrome 99 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

Establece el valor del parámetro CGI ap 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

    string

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

    función

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

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

    • solicitud

      cualquiera

    • sendResponse

      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 otra extensión envía una solicitud.

Parámetros

  • callback

    función

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

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

    • solicitud

      cualquiera

    • sendResponse

      función

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

      () => void