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 Transferencia de mensajes.
Tipos
ViewType
Es el tipo de vista de extensión.
Enum
“pestaña”
“popup”
Propiedades
inIncognitoContext
Verdadero 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. Este último solo se aplica a las extensiones con el atributo “split” comportamiento_incógnito.
Tipo
boolean
lastError
Usa runtime.lastError
.
Se establece durante la vida útil de una devolución de llamada si una API de extensión asíncrona generó un error. Si no se ha producido ningún error, el último error será undefined
.
Tipo
objeto
Propiedades
-
mensaje
string
Descripción del error que ocurrió.
Métodos
getBackgroundPage()
chrome.extension.getBackgroundPage()
Devuelve la "ventana" de JavaScript. objeto de la página en segundo plano que se ejecuta dentro de la extensión actual. Muestra null si la extensión no tiene página en segundo plano.
Muestra
-
Ventana | indefinido
getExtensionTabs()
chrome.extension.getExtensionTabs(
windowId?: number,
)
Usa extension.getViews
{type: "tab"}
.
Devuelve un array de la "ventana" de JavaScript. objetos para cada una de las pestañas que se ejecutan dentro de la extensión actual. Si se especifica windowId
, solo muestra la “ventana”. objetos de pestañas adjuntas a la ventana especificada.
Parámetros
-
windowId
número opcional
Muestra
-
Ventana
Arreglo de objetos de ventana global
getURL()
chrome.extension.getURL(
path: 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
Una ruta de acceso a un recurso dentro de una extensión expresada en relación con su directorio de instalación.
Muestra
-
string
Es la URL completamente calificada al recurso.
getViews()
chrome.extension.getViews(
fetchProperties?: object,
)
Devuelve un array de la "ventana" de JavaScript. objetos 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 posterioresBusca 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 debe obtener. Si se omite, muestra todas las vistas (incluidas las pestañas y las páginas en segundo plano).
-
windowId
número opcional
La ventana a la que se restringe la búsqueda. Si se omite, muestra todas las vistas.
-
Muestra
-
Ventana
Array de objetos globales
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
Recupera el estado del acceso de la extensión a "file://" . Esto corresponde a la opción "Permitir acceso a las URLs de archivos" controlada por el usuario por extensión 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
boolean
Es verdadero si la extensión puede acceder al archivo "file://". esquema; de lo contrario, es falso.
-
Muestra
-
Promise<boolean>
Chrome 99 y versiones posterioresLas promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.
isAllowedIncognitoAccess()
chrome.extension.isAllowedIncognitoAccess(
callback?: function,
)
Recupera el estado del acceso de la extensión al modo Incógnito. Corresponde a la opción "Permitida en modo Incógnito" por extensión controlada por el usuario 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
boolean
Verdadero si la extensión tiene acceso al modo Incógnito; de lo contrario, es falso.
-
Muestra
-
Promise<boolean>
Chrome 99 y versiones posterioresLas promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.
sendRequest()
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 solicitud con una respuesta opcional. El evento extension.onRequest
se activa en cada página de la extensión.
Parámetros
-
extensionId
string opcional
El ID de la extensión a la que deseas conectarte. Si se omite, la opción predeterminada será tu propia extensión.
-
request
cualquiera
-
callback
función opcional
Chrome 99 y versiones posterioresEl parámetro
callback
se ve de la siguiente manera:(response: any) => void
-
respuesta
cualquiera
El objeto de respuesta JSON que envía 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
runtime.lastError
se establecerá en el mensaje de error.
-
Muestra
-
Promesa<cualquiera>
Chrome 99 y versiones posterioresLas promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El 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 utiliza 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
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
-
request
cualquiera
-
remitente
-
sendResponse
función
El parámetro
sendResponse
se ve de la siguiente manera:() => void
-
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
Usa runtime.onMessageExternal
.
Se activa cuando se envía una solicitud desde otra extensión.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
request
cualquiera
-
remitente
-
sendResponse
función
El parámetro
sendResponse
se ve de la siguiente manera:() => void
-