chrome.extensie

Beschrijving

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

Soorten

ViewType

Chrome 44+

Het type extensieweergave.

Enum

"tab"

"pop-up"

Eigenschappen

inIncognitoContext

Dit geldt voor scripts die in incognito-tabbladen worden uitgevoerd, en voor extensiepagina's die in een incognito-proces draaien. Het laatste geldt alleen voor extensies met 'split' incognito_behavior.

Type

booleaans

lastError

≤ MV2 Verouderd sinds Chrome 58

Gebruik alstublieft runtime.lastError .

Deze waarde wordt 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 opgetreden fout.

Methoden

getBackgroundPage()

Alleen op de 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.

Retourneert

  • Venster | niet gedefinieerd

getExtensionTabs()

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

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

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

Parameters

  • venster-ID

    nummer optioneel

Retourneert

  • Raam[]

    Array van globale vensterobjecten

getURL()

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

Gebruik alstublieft runtime.getURL .

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

Parameters

  • pad

    snaar

    Een pad naar een bron binnen een extensie, uitgedrukt ten opzichte van de installatiemap.

Retourneert

  • snaar

    De volledig gekwalificeerde URL naar de bron.

getViews()

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

Retourneert een array met de JavaScript 'window'-objecten voor elk van de pagina's die binnen de huidige extensie worden uitgevoerd.

Parameters

  • eigenschappen ophalen

    object optioneel

    • tabId

      nummer optioneel

      Chrome 54+

      Zoek een weergave op basis van een tab-ID. Als dit veld ontbreekt, 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 waarbinnen de zoekopdracht moet worden beperkt. Indien weggelaten, worden alle weergaven geretourneerd.

Retourneert

  • Raam[]

    Array van globale objecten

isAllowedFileSchemeAccess()

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

Hiermee wordt de toegangsstatus van de extensie tot het 'file://'-schema opgevraagd. Dit komt overeen met de door de gebruiker ingestelde extensie-specifieke instelling 'Toegang tot bestands-URL's toestaan', die toegankelijk is via de pagina chrome://extensions.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleaans

      Retourneert waar als de extensie toegang heeft tot het 'file://'-schema, anders niet.

Retourneert

  • Belofte<boolean>

    Chrome 99+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

isAllowedIncognitoAccess()

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

Geeft de status weer van de toegang van de extensie tot de incognitomodus. Dit komt overeen met de door de gebruiker ingestelde 'Toegestaan ​​in incognitomodus' per extensie, die toegankelijk is via de pagina chrome://extensions.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booleaans

      Retourneert waar als de extensie toegang heeft tot de incognitomodus, anders niet.

Retourneert

  • Belofte<boolean>

    Chrome 99+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

sendRequest()

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

Gebruik alstublieft runtime.sendMessage .

Verstuurt één verzoek naar andere luisteraars binnen de extensie. Vergelijkbaar met runtime.connect , maar verstuurt slechts één verzoek met een optioneel antwoord. De extension.onRequest -gebeurtenis 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, wordt standaard uw eigen extensie gebruikt.

  • verzoek

    elk

  • terugbelverzoek

    functie optioneel

    Chrome 99+

    De callback parameter ziet er als volgt uit: 

    (response: any) => void

    • antwoord

      elk

      Het JSON-antwoordobject dat door de handler van het verzoek wordt verzonden. Als er een fout optreedt tijdens het verbinden met de extensie, wordt de promise afgewezen.

Retourneert

  • Belofte<willekeurig>

    Chrome 99+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setUpdateUrlData()

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

Hiermee wordt de waarde van de ap CGI-parameter ingesteld 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

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

Gebruik alstublieft runtime.onMessage .

Wordt geactiveerd wanneer een verzoek wordt verzonden vanuit een extensieproces of een contentscript.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • verzoek

      elk

    • antwoord verzenden

      functie

      De parameter sendResponse ziet er als volgt uit: 

      () => void

onRequestExternal

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

Gebruik alstublieft runtime.onMessageExternal .

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

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

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

    • verzoek

      elk

    • antwoord verzenden

      functie

      De parameter sendResponse ziet er als volgt uit: 

      () => void