chrome.extension

Beschreibung

Die chrome.extension API bietet Dienstprogramme, die auf jeder Erweiterungsseite verwendet werden können. Es unterstützt den Austausch von Nachrichten zwischen einer Erweiterung und ihren Inhaltsscripts oder zwischen Erweiterungen, wie im Abschnitt Nachrichtenübergabe ausführlich beschrieben.

Typen

ViewType

Chrome 44 und höher

Der Typ der Erweiterungsansicht.

Enum

Tabulatortaste

"popup"

Attribute

inIncognitoContext

Wahr für Content-Scripts, die in Inkognitotabs ausgeführt werden, und für Erweiterungsseiten, die in einem Inkognitoprozess ausgeführt werden. Letzteres gilt nur für Erweiterungen mit „split“ als incognito_behavior.

Typ

boolean

lastError

≤ MV2 Seit Chrome 58 eingestellt

Verwenden Sie runtime.lastError.

Wird für die Lebensdauer eines Rückrufs festgelegt, wenn eine asynchrone Erweiterungs-API zu einem Fehler geführt hat. Wenn kein Fehler aufgetreten ist, ist „lastError“ undefined.

Typ

Objekt

Attribute

  • Nachricht

    String

    Beschreibung des aufgetretenen Fehlers.

Methoden

getBackgroundPage()

Nur im Vordergrund 
chrome.extension.getBackgroundPage()

Gibt das JavaScript-Objekt „window“ für die Hintergrundseite zurück, die in der aktuellen Erweiterung ausgeführt wird. Gibt null zurück, wenn die Erweiterung keine Hintergrundseite hat.

Ausgabe

  • Fenster | undefiniert

getExtensionTabs()

≤ MV2 Nur Vordergrund Eingestellt
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Bitte verwenden Sie extension.getViews {type: "tab"}.

Gibt ein Array der JavaScript-Objekte „window“ für jeden Tab zurück, der in der aktuellen Erweiterung ausgeführt wird. Wenn windowId angegeben ist, werden nur die „window“-Objekte der Tabs zurückgegeben, die mit dem angegebenen Fenster verknüpft sind.

Parameter

  • windowId

    number optional

Ausgabe

  • Window[]

    Array globaler Fensterobjekte

getURL()

≤ MV2 Seit Chrome 58 eingestellt
chrome.extension.getURL(
  path: string,
)

Verwenden Sie runtime.getURL.

Konvertiert einen relativen Pfad in einem Installationsverzeichnis einer Erweiterung in eine vollständig qualifizierte URL.

Parameter

  • Pfad

    String

    Ein Pfad zu einer Ressource innerhalb einer Erweiterung, relativ zum Installationsverzeichnis.

Ausgabe

  • String

    Die vollständig qualifizierte URL zur Ressource.

getViews()

Nur im Vordergrund 
chrome.extension.getViews(
  fetchProperties?: object,
)

Gibt ein Array der JavaScript-Objekte „window“ für jede der Seiten zurück, die in der aktuellen Erweiterung ausgeführt werden.

Parameter

  • fetchProperties

    object optional

    • tabId

      number optional

      Chrome 54 und höher

      Eine Ansicht anhand einer Tab-ID suchen Wenn dieses Feld weggelassen wird, werden alle Datenansichten zurückgegeben.

    • Typ

      ViewType optional

      Der Typ der Ansicht, die abgerufen werden soll. Wenn Sie diesen Parameter weglassen, werden alle Aufrufe zurückgegeben (einschließlich Hintergrundseiten und Tabs).

    • windowId

      number optional

      Der Zeitraum, auf den die Suche beschränkt werden soll. Wenn Sie diese Option weglassen, werden alle Ansichten zurückgegeben.

Ausgabe

  • Window[]

    Array von globalen Objekten

isAllowedFileSchemeAccess()

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

Ruft den Status des Zugriffs der Erweiterung auf das Schema „file://“ ab. Diese Einstellung entspricht der vom Nutzer verwalteten Einstellung „Zugriff auf Datei-URLs zulassen“, die pro Erweiterung festgelegt werden kann und über die Seite chrome://extensions aufgerufen werden kann.

Parameter

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      „True“, wenn die Erweiterung auf das Schema „file://“ zugreifen kann, andernfalls „false“.

Ausgabe

  • Promise<boolean>

    Chrome 99 und höher

    Versprechen werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

isAllowedIncognitoAccess()

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

Ruft den Status des Zugriffs der Erweiterung auf den Inkognitomodus ab. Diese Einstellung entspricht der vom Nutzer verwalteten Einstellung „Im Inkognitomodus erlaubt“, die pro Erweiterung über die Seite chrome://extensions aufgerufen werden kann.

Parameter

  • callback

    function optional

    Der Parameter callback sieht so aus: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      „True“, wenn die Erweiterung Zugriff auf den Inkognitomodus hat, andernfalls „false“.

Ausgabe

  • Promise<boolean>

    Chrome 99 und höher

    Versprechen werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

sendRequest()

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

Verwenden Sie runtime.sendMessage.

Es wird eine einzelne Anfrage an andere Listener innerhalb der Erweiterung gesendet. Ähnlich wie runtime.connect, es wird jedoch nur eine einzelne Anfrage mit einer optionalen Antwort gesendet. Das Ereignis extension.onRequest wird auf jeder Seite der Erweiterung ausgelöst.

Parameter

  • extensionId

    String optional

    Die Erweiterungs-ID der Erweiterung, mit der Sie eine Verbindung herstellen möchten. Wenn keine Angabe gemacht wird, wird standardmäßig Ihre eigene Erweiterung verwendet.

  • Anfrage

    beliebig

  • callback

    function optional

    Chrome 99 und höher

    Der Parameter callback sieht so aus: 

    (response: any) => void

    • Antwort

      beliebig

      Das JSON-Antwortobjekt, das vom Handler der Anfrage gesendet wird. Wenn beim Herstellen einer Verbindung zur Erweiterung ein Fehler auftritt, wird der Rückruf ohne Argumente aufgerufen und runtime.lastError wird auf die Fehlermeldung gesetzt.

Ausgabe

  • Promise<any>

    Chrome 99 und höher

    Versprechen werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Hiermit wird der Wert des CGI-Parameters „ap“ festgelegt, der in der Update-URL der Erweiterung verwendet wird. Bei Erweiterungen, die in der Chrome-Erweiterungsgalerie gehostet werden, wird dieser Wert ignoriert.

Parameter

  • Daten

    String

Ereignisse

onRequest

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

Verwenden Sie runtime.onMessage.

Wird ausgelöst, wenn eine Anfrage entweder von einem Erweiterungsprozess oder einem Inhaltsskript gesendet wird.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • Anfrage

      beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: 

      () => void

onRequestExternal

&leq; MV2 Verworfen
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Verwenden Sie runtime.onMessageExternal.

Wird ausgelöst, wenn eine Anfrage von einer anderen Erweiterung gesendet wird.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • Anfrage

      beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: 

      () => void