chrome.extension

Descrizione

L'API chrome.extension contiene 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 le estensioni, come descritto in dettaglio nella sezione Trasmissione di messaggi.

Tipi

ViewType

Chrome 44 e versioni successive

Il tipo di visualizzazione dell'estensione.

Enum

"popup"

Proprietà

inIncognitoContext

True per gli script di contenuti in esecuzione all'interno di schede di navigazione in incognito e per le pagine di estensioni in esecuzione all'interno di un processo di navigazione in incognito. Il secondo si applica solo alle estensioni con "split" in incognito_behavior.

Tipo

boolean

lastError

≤ MV2 Obsoleto da Chrome 58

Utilizza runtime.lastError.

Imposta la durata di un callback se un'API di estensione anonica 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()

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

Ritorni

  • Finestra|non definita

getExtensionTabs()

≤ MV2 Solo in primo piano Deprecata
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

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

Parametri

  • windowId

    numero facoltativo

Ritorni

  • Finestra[]

    Array di oggetti finestra globali

getURL()

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

Utilizza runtime.getURL.

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

Parametri

  • percorso

    stringa

    Percorso di una risorsa all'interno di un'estensione espresso in relazione alla relativa directory di installazione.

Ritorni

  • stringa

    L'URL completo della risorsa.

getViews()

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

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

Parametri

  • fetchProperties

    oggetto facoltativo

    • tabId

      numero facoltativo

      Chrome 54 e versioni successive

      Cerca una visualizzazione in base a un ID scheda. Se questo campo viene omesso, restituisce tutte le viste.

    • tipo

      ViewType facoltativo

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

    • windowId

      numero facoltativo

      La finestra a cui limitare la ricerca. Se omesso, restituisce tutte le viste.

Ritorni

  • Finestra[]

    Array di oggetti globali

isAllowedFileSchemeAccess()

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

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

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      True se l'estensione può accedere allo schema "file://", altrimenti è false.

Ritorni

  • Promise<boolean>

    Chrome 99 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

isAllowedIncognitoAccess()

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

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

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean)=>void

    • isAllowedAccess

      boolean

      True se l'estensione ha accesso alla modalità di navigazione in incognito, false negli altri casi.

Ritorni

  • Promise<boolean>

    Chrome 99 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

sendRequest()

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

Utilizza runtime.sendMessage.

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

Parametri

  • extensionId

    stringa facoltativo

    L'ID dell'estensione a cui vuoi collegarti. Se omessa, l'estensione predefinita è la tua.

  • richiesta

    Qualsiasi

  • callback

    funzione facoltativa

    Chrome 99 e versioni successive

    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, verrà chiamato il callback senza argomenti e runtime.lastError verrà impostato sul messaggio di errore.

Ritorni

  • Promessa<qualsiasi>

    Chrome 99 e versioni successive

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

Parametri

  • dati

    stringa

Eventi

onRequest

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

Utilizza runtime.onMessage.

Attivato quando viene inviata una richiesta da un processo di estensione o da uno script di 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 Deprecata
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