chrome.extension

Descrizione

L'API chrome.extension dispone di utilità che possono essere utilizzate da qualsiasi pagina di estensione. Include il supporto per lo scambio di messaggi tra un'estensione e i relativi script di contenuti o tra estensioni, come descritto in dettaglio in Trasmissione di messaggi.

Tipi

ViewType

Chrome 44+

Il tipo di visualizzazione dell'estensione.

Enum

"tab"

"popup"

Proprietà

inIncognitoContext

Vero per gli script di contenuti eseguiti all'interno delle schede di navigazione in incognito e per le pagine delle estensioni eseguite all'interno di un processo di navigazione in incognito. Quest'ultima si applica solo alle estensioni con incognito_behavior "split".

Tipo

booleano

lastError

≤ MV2 Ritirato a partire da Chrome 58

Utilizza runtime.lastError.

Impostato per la durata di un callback se un'API di estensione asincrona ha generato un errore. Se non si è verificato alcun errore, lastError sarà undefined.

Tipo

oggetto

Proprietà

  • messaggio

    stringa

    Descrizione dell'errore che si è verificato.

Metodi

getBackgroundPage()

Solo in primo piano 
chrome.extension.getBackgroundPage(): Window | undefined

Restituisce l'oggetto "window" JavaScript per la pagina di sfondo in esecuzione all'interno dell'estensione corrente. Restituisce null se l'estensione non ha una pagina di sfondo.

Resi

  • Finestra | undefined

getExtensionTabs()

≤ MV2 Solo in primo piano Ritirato
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

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

Restituisce un array degli oggetti "window" JavaScript per ciascuna delle schede in esecuzione all'interno dell'estensione corrente. Se windowId è specificato, restituisce solo gli oggetti "finestra" delle schede associate alla finestra specificata.

Parametri

  • windowId

    number (facoltativo)

Resi

  • Window[]

    Array di oggetti finestra globali

getURL()

≤ MV2 Ritirato a partire da Chrome 58
chrome.extension.getURL(
  path: string,
): string

Utilizza runtime.getURL.

Converte un percorso relativo all'interno di una directory di installazione dell'estensione in un URL completo.

Parametri

  • percorso

    stringa

    Un percorso a una risorsa all'interno di un'estensione espresso in modo relativo alla directory di installazione.

Resi

  • stringa

    L'URL completo della risorsa.

getViews()

Solo in primo piano 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

Restituisce un array degli oggetti "window" JavaScript per ciascuna delle pagine in esecuzione all'interno dell'estensione corrente.

Parametri

  • fetchProperties

    oggetto facoltativo

    • tabId

      number (facoltativo)

      Chrome 54 o versioni successive

      Trova una visualizzazione in base a un ID scheda. Se questo campo viene omesso, vengono restituite tutte le visualizzazioni.

    • tipo

      ViewType facoltativo

      Il tipo di visualizzazione da ottenere. Se omesso, restituisce tutte le visualizzazioni (incluse le pagine e le schede in background).

    • windowId

      number (facoltativo)

      La finestra in cui limitare la ricerca. Se omesso, vengono restituite tutte le visualizzazioni.

Resi

  • Window[]

    Array di oggetti globali

isAllowedFileSchemeAccess()

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

Recupera lo stato dell'accesso dell'estensione allo schema "file://". Corrisponde all'impostazione "Consenti l'accesso agli URL dei file" controllata dall'utente per ogni estensione, accessibile tramite la pagina chrome://extensions.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

      Vero se l'estensione può accedere allo schema "file://", falso in caso contrario.

Resi

  • Promise<boolean>

    Chrome 99+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

isAllowedIncognitoAccess()

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

Recupera lo stato dell'accesso dell'estensione alla modalità di navigazione in incognito. Corrisponde all'impostazione "Consentita in modalità di navigazione in incognito" controllata dall'utente per ogni estensione accessibile tramite la pagina chrome://extensions.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

      Vero se l'estensione ha accesso alla modalità di navigazione in incognito, falso in caso contrario.

Resi

  • Promise<boolean>

    Chrome 99+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

sendRequest()

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

Utilizza runtime.sendMessage.

Invia una singola richiesta ad altri ascoltatori all'interno dell'estensione. Simile a runtime.connect, ma invia una sola richiesta con una risposta facoltativa. L'evento extension.onRequest viene attivato in ogni pagina dell'estensione.

Parametri

  • extensionId

    stringa facoltativa

    L'ID estensione dell'estensione a cui vuoi connetterti. Se omesso, il valore predefinito è la tua estensione.

  • richiesta

    qualsiasi

  • callback

    funzione facoltativa

    Chrome 99+

    Il parametro callback ha il seguente aspetto: 

    (response: any) => void

    • risposta

      qualsiasi

      L'oggetto di risposta JSON inviato dal gestore della richiesta. Se si verifica un errore durante la connessione all'estensione, il callback verrà chiamato senza argomenti e runtime.lastError verrà impostato sul messaggio di errore.

Resi

  • Promise<any>

    Chrome 99+

    Le promesse sono supportate solo per Manifest V3 e versioni successive, le altre piattaforme devono utilizzare i callback.

setUpdateUrlData()

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

Imposta il valore del parametro CGI ap utilizzato nell'URL di aggiornamento dell'estensione. Questo valore viene ignorato per le estensioni ospitate nella galleria delle estensioni di Chrome.

Parametri

  • dati

    stringa

Eventi

onRequest

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

Utilizza runtime.onMessage.

Attivato quando una richiesta viene inviata da un processo di estensione o da uno script dei contenuti.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

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

    • richiesta

      qualsiasi

    • sendResponse

      funzione

      Il parametro sendResponse ha il seguente aspetto: 

      () => void

onRequestExternal

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

Utilizza runtime.onMessageExternal.

Attivato quando viene inviata una richiesta da un'altra estensione.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

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

    • richiesta

      qualsiasi

    • sendResponse

      funzione

      Il parametro sendResponse ha il seguente aspetto: 

      () => void