chrome.extensie

Beschrijving

De chrome.extension API bevat hulpprogramma's die door elke extensiepagina kunnen worden gebruikt. Het omvat ondersteuning voor het uitwisselen van berichten tussen een extensie en de bijbehorende contentscripts of tussen extensies onderling, zoals gedetailleerd beschreven in Berichten doorgeven .

Typen

ViewType

Chroom 44+

Het type extensieweergave.

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

Booleaanse

lastError

≤ MV2 Verouderd sinds Chrome 58

Gebruik runtime.lastError .

Ingesteld voor de levensduur van een callback als een asynchrone extensie-API een fout heeft veroorzaakt. Als er geen fout is opgetreden, is lastError undefined .

Type

voorwerp

Eigenschappen

  • bericht

    snaar

    Beschrijving van de fout die heeft plaatsgevonden.

Methoden

getBackgroundPage()

Alleen voorgrond
chrome.extension.getBackgroundPage(): Window | undefined

Retourneert het JavaScript 'window'-object voor de achtergrondpagina die binnen de huidige extensie wordt uitgevoerd. Retourneert null als de extensie geen achtergrondpagina heeft.

Retourneren

  • Venster | ongedefinieerd

getExtensionTabs()

≤ MV2 Alleen voorgrond Verouderd
 
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

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

Retourneert een array van de JavaScript 'window'-objecten voor elk van de tabbladen die binnen de huidige extensie actief zijn. Als windowId is opgegeven, worden alleen de 'window'-objecten geretourneerd van tabbladen die aan het opgegeven venster zijn gekoppeld.

Parameters

  • venster-ID

    nummer optioneel

Retourneren

  • Raam[]

    Array van globale vensterobjecten

getURL()

≤ MV2 Verouderd sinds Chrome 58
 
chrome.extension.getURL(
  path: string,
): string

Gebruik runtime.getURL .

Converteert een relatief pad binnen een installatiemap van een extensie naar een volledig gekwalificeerde URL.

Parameters

  • pad

    snaar

    Een pad naar een resource binnen een extensie, uitgedrukt in relatieve zin ten opzichte van de installatiedirectory.

Retourneren

  • snaar

    De volledig gekwalificeerde URL naar de bron.

getViews()

Alleen voorgrond
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

Retourneert een array van de JavaScript 'window'-objecten voor elke pagina die binnen de huidige extensie wordt uitgevoerd.

Parameters

  • fetchProperties

    object optioneel

    • tabbladId

      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 moet worden opgehaald. Indien weggelaten, worden alle weergaven geretourneerd (inclusief achtergrondpagina's en tabbladen).

    • venster-ID

      nummer optioneel

      Het venster waartoe de zoekopdracht moet worden beperkt. Als dit venster wordt weggelaten, worden alle weergaven geretourneerd.

Retourneren

  • Raam[]

    Array van globale objecten

isAllowedFileSchemeAccess()

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

Haalt de status op van de toegang van de extensie tot het 'file://'-schema. Dit komt overeen met de door de gebruiker per extensie ingestelde instelling 'Toegang tot bestands-URL's toestaan', die toegankelijk is via de pagina chrome://extensions.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (isAllowedAccess: boolean) => void

    • isToegestaneToegang

      Booleaanse

      True als de extensie toegang heeft tot het 'file://'-schema, anders false.

Retourneren

  • Belofte<boolean>

    Chroom 99+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

isAllowedIncognitoAccess()

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

Haalt de status op van de toegang van de extensie tot de incognitomodus. Dit komt overeen met de door de gebruiker ingestelde instelling 'Toegestaan in incognito' per extensie, toegankelijk via de pagina chrome://extensions.

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (isAllowedAccess: boolean) => void

    • isToegestaneToegang

      Booleaanse

      True als de extensie toegang heeft tot de incognitomodus, anders false.

Retourneren

  • Belofte<boolean>

    Chroom 99+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

sendRequest()

Belofte ≤ MV2 Verouderd
 
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

Gebruik runtime.sendMessage .

Stuurt één verzoek naar andere listeners binnen de extensie. Vergelijkbaar met runtime.connect , maar stuurt slechts één verzoek met een optioneel antwoord. De gebeurtenis extension.onRequest wordt op elke pagina van de extensie geactiveerd.

Parameters

  • extensie-ID

    string optioneel

    De extensie-ID van de extensie waarmee u verbinding wilt maken. Indien weggelaten, is de standaard uw eigen extensie.

  • verzoek

    elk

  • terugbellen

    functie optioneel

    Chroom 99+

    De callback ziet er als volgt uit: 

    (response: any) => void

    • antwoord

      elk

      Het JSON-responsobject dat door de handler van de aanvraag is verzonden. Als er een fout optreedt tijdens het verbinden met de extensie, wordt de callback aangeroepen zonder argumenten en wordt runtime.lastError ingesteld op de foutmelding.

Retourneren

  • Beloof<elke>

    Chroom 99+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setUpdateUrlData()

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

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 Extension Gallery.

Parameters

  • gegevens

    snaar

Evenementen

onRequest

≤ MV2 Verouderd
 
chrome.extension.onRequest.addListener(
  callback: function,
)

Gebruik runtime.onMessage .

Wordt geactiveerd wanneer een verzoek wordt verzonden vanuit een uitbreidingsproces of een inhoudsscript.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

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

    • verzoek

      elk

    • antwoord verzenden

      functie

      De sendResponse parameter ziet er als volgt uit: 

      () => void

onRequestExternal

≤ MV2 Verouderd
 
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Gebruik runtime.onMessageExternal .

Wordt geactiveerd wanneer een verzoek wordt verzonden vanaf een andere extensie.

Parameters

  • terugbellen

    functie

    De callback ziet er als volgt uit: 

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

    • verzoek

      elk

    • antwoord verzenden

      functie

      De sendResponse parameter ziet er als volgt uit: 

      () => void