Beschrijving
De chrome.extension
API heeft hulpprogramma's die door elke extensiepagina kunnen worden gebruikt. Het bevat ondersteuning voor het uitwisselen van berichten tussen een extensie en de inhoudsscripts of tussen extensies, zoals in detail beschreven in Berichten doorgeven .
Soorten
ViewType
Het type uitbreidingsweergave.
Enum
"tabblad" "pop-up"
Eigenschappen
inIncognitoContext
Geldt voor inhoudsscripts die binnen incognitotabbladen worden uitgevoerd, en voor extensiepagina's die binnen een incognitoproces worden uitgevoerd. Dit laatste geldt alleen voor extensies met ‘split’ incognito_behavior.
Type
Booleaans
lastError
Gebruik runtime.lastError
.
Ingesteld voor de levensduur van een callback als een ansynchrone extensie-API tot een fout heeft geleid. Als er geen fout is opgetreden, is lastError undefined
.
Type
voorwerp
Eigenschappen
- bericht
snaar
Beschrijving van de fout die heeft plaatsgevonden.
Methoden
getBackgroundPage()
chrome.extension.getBackgroundPage()
Retourneert het JavaScript 'window'-object voor de achtergrondpagina die binnen de huidige extensie wordt uitgevoerd. Retourneert null als de extensie geen achtergrondpagina heeft.
Retouren
Venster | ongedefinieerd
getExtensionTabs()
chrome.extension.getExtensionTabs(
windowId?: number,
)
Gebruik extension.getViews
{type: "tab"}
.
Retourneert een array van de JavaScript-'venster'-objecten voor elk van de tabbladen die binnen de huidige extensie worden uitgevoerd. Als windowId
is opgegeven, worden alleen de 'window'-objecten geretourneerd van tabbladen die aan het opgegeven venster zijn gekoppeld.
Parameters
- vensterId
nummer optioneel
Retouren
Raam[]
Array van globale vensterobjecten
getURL()
chrome.extension.getURL(
path: string,
)
Gebruik runtime.getURL
.
Converteert een relatief pad binnen een installatiemap voor een extensie naar een volledig gekwalificeerde URL.
Parameters
- pad
snaar
Een pad naar een bron binnen een extensie, uitgedrukt ten opzichte van de installatiemap ervan.
Retouren
snaar
De volledig gekwalificeerde URL naar de bron.
getViews()
chrome.extension.getViews(
fetchProperties?: object,
)
Retourneert een array van de JavaScript-'venster'-objecten voor elk van de pagina's die binnen de huidige extensie worden uitgevoerd.
Parameters
- fetchProperties
object optioneel
- tabId
nummer optioneel
Chroom 54+Zoek een weergave op basis van een tabblad-ID. Als dit veld wordt weggelaten, worden alle weergaven geretourneerd.
- type
ViewType optioneel
Het type weergave dat u wilt krijgen. Als u dit weglaat, worden alle weergaven geretourneerd (inclusief achtergrondpagina's en tabbladen).
- vensterId
nummer optioneel
Het venster waarin u de zoekopdracht wilt beperken. Indien weggelaten, worden alle weergaven geretourneerd.
Retouren
Raam[]
Array van globale objecten
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
Haalt de status op van de toegang van de extensie tot het 'file://'-schema. Dit komt overeen met de door de gebruiker beheerde instelling 'Toegang tot bestands-URL's toestaan' per extensie, toegankelijk via de pagina chrome://extensions.
Parameters
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(isAllowedAccess: boolean) => void
- isAllowedAccess
Booleaans
True als de extensie toegang heeft tot het 'file://'-schema, anders false.
Retouren
Beloof<boolean>
Chroom 99+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
isAllowedIncognitoAccess()
chrome.extension.isAllowedIncognitoAccess(
callback?: function,
)
Haalt de status op van de toegang van de extensie tot de incognitomodus. Dit komt overeen met de door de gebruiker beheerde instelling 'Toegestaan in incognito' per extensie, toegankelijk via de pagina chrome://extensions.
Parameters
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(isAllowedAccess: boolean) => void
- isAllowedAccess
Booleaans
Waar als de extensie toegang heeft tot de incognitomodus, anders onwaar.
Retouren
Beloof<boolean>
Chroom 99+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
sendRequest()
chrome.extension.sendRequest(
extensionId?: string,
request: any,
callback?: function,
)
Gebruik runtime.sendMessage
.
Stuurt één verzoek naar andere luisteraars binnen de extensie. Vergelijkbaar met runtime.connect
, maar verzendt slechts één verzoek met een optioneel antwoord. De gebeurtenis extension.onRequest
wordt op elke pagina van de extensie geactiveerd.
Parameters
- extensieId
tekenreeks optioneel
De extensie-ID van de extensie waarmee u verbinding wilt maken. Als u dit weglaat, is dit standaard uw eigen extensie.
- verzoek
elk
- terugbellen
functie optioneel
Chroom 99+De
callback
parameter ziet er als volgt uit:(response: any) => void
- antwoord
elk
Het JSON-antwoordobject dat door de handler van de aanvraag is verzonden. Als er een fout optreedt tijdens het verbinden met de extensie, wordt de callback zonder argumenten aangeroepen en wordt
runtime.lastError
ingesteld op het foutbericht.
Retouren
Beloof<elke>
Chroom 99+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
setUpdateUrlData()
chrome.extension.setUpdateUrlData(
data: string,
)
Stelt de waarde in van de ap CGI-parameter die wordt gebruikt in de update-URL van de extensie. Deze waarde wordt genegeerd voor extensies die worden gehost in de Chrome Extensiegalerij.
Parameters
- gegevens
snaar
Evenementen
onRequest
chrome.extension.onRequest.addListener(
callback: function,
)
Gebruik runtime.onMessage
.
Wordt geactiveerd wanneer een verzoek wordt verzonden vanuit een extensieproces of een inhoudsscript.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
- verzoek
elk
- afzender
- stuur antwoord
functie
De
sendResponse
parameter ziet er als volgt uit:() => void
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
Gebruik runtime.onMessageExternal
.
Wordt geactiveerd wanneer een verzoek wordt verzonden vanaf een ander toestel.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(request: any, sender: runtime.MessageSender, sendResponse: function) => void
- verzoek
elk
- afzender
- stuur antwoord
functie
De
sendResponse
parameter ziet er als volgt uit:() => void