chrome.extension

Descrizione

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

Tipi

ViewType

Chrome 44 e versioni successive .

Il tipo di visualizzazione dell'estensione.

Enum

"scheda"

"popup"

Proprietà

inIncognitoContext

True per gli script di contenuti eseguiti all'interno di schede di navigazione in incognito e per le pagine di estensioni eseguite nell'ambito di un processo di navigazione in incognito. Quest'ultimo si applica solo alle estensioni con "split" navigazione_in incognito.

Tipo

booleano

lastError

≤ MV2 Ritirato da Chrome 58

Utilizza runtime.lastError.

Imposta la durata di un callback se un'API dell'estensione asincrona ha generato un errore. Se non si è verificato alcun errore, l'ultimo errore sarà undefined.

Tipo

oggetto

Proprietà

  • messaggio

    stringa

    Descrizione dell'errore che si è verificato.

Metodi

getBackgroundPage()

Solo in primo piano .
chrome.extension.getBackgroundPage()

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

Resi

  • Finestra | non definito

getExtensionTabs()

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

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

Restituisce un array della "window" JavaScript per ognuna delle schede all'interno dell'estensione corrente. Se windowId è specificato, restituisce solo "window" oggetti di schede collegate alla finestra specificata.

Parametri

  • windowId

    numero facoltativo

Resi

  • Finestra[]

    Array di oggetti finestra globali

getURL()

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

Utilizza runtime.getURL.

Converte un percorso relativo all'interno di una directory di installazione delle estensioni in un URL completo.

Parametri

  • percorso

    stringa

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

Resi

  • stringa

    L'URL completo della risorsa.

getViews()

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

Restituisce un array della "window" JavaScript per ognuna delle pagine eseguite all'interno dell'estensione corrente.

Parametri

  • fetchProperties

    oggetto facoltativo

    • tabId

      numero facoltativo

      Chrome 54 e versioni successive .

      Trova 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 visualizzazioni.

Resi

  • Finestra[]

    Array di oggetti globali

isAllowedFileSchemeAccess()

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

Recupera lo stato dell'accesso dell'estensione a "file://" . Corrisponde al parametro "Consenti l'accesso agli URL dei file" per estensione, controllato dall'utente accessibile dalla pagina chrome://extensions.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

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

Resi

  • Promise<boolean>

    Chrome 99 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

isAllowedIncognitoAccess()

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

Recupera lo stato dell'accesso dell'estensione alla modalità di navigazione in incognito. Corrisponde al valore per estensione "Consentito in modalità di navigazione in incognito" controllato dall'utente accessibile dalla pagina chrome://extensions.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleano

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

Resi

  • Promise<boolean>

    Chrome 99 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

sendRequest()

Promesso ≤ MV2 Deprecato
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 una sola 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 connetterti. Se omesso, il valore predefinito è la tua estensione.

  • richiesta

    qualsiasi

  • callback

    funzione facoltativa

    Chrome 99 e versioni successive .

    Il parametro callback ha il seguente aspetto: 

    (response: any) => void

    • risposta

      qualsiasi

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

Resi

  • Promesso<qualsiasi>

    Chrome 99 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato 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

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

Utilizza runtime.onMessage.

Attivato quando viene inviata una richiesta 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

&amp;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