chrome.extension

Beschreibung

Die chrome.extension API enthält Dienstprogramme, die von jeder Erweiterungsseite verwendet werden können. Sie bietet Unterstützung für den Austausch von Nachrichten zwischen einer Erweiterung und ihren Inhaltskripten oder zwischen Erweiterungen, wie in Message Passing ausführlich beschrieben.

Typen

ViewType

Chrome 44 und höher

Der Typ der Erweiterungsansicht.

Enum

"tab"

"popup"

Attribute

inIncognitoContext

Gilt für Content-Skripts, die in Inkognitotabs ausgeführt werden, und für Erweiterungsseiten, die in einem Inkognitoprozess ausgeführt werden. Letzteres gilt nur für Erweiterungen mit dem Inkognitomodus-Verhalten „split“.

Typ

boolean

lastError

≤ MV2 Seit Chrome 58 eingestellt

Verwenden Sie runtime.lastError.

Wird für die Lebensdauer eines Callbacks festgelegt, wenn bei einer asynchronen Erweiterungs-API ein Fehler aufgetreten ist. 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(): Window | undefined

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 | nicht definiert

getExtensionTabs()

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

Verwenden Sie extension.getViews {type: "tab"}.

Gibt ein Array der JavaScript-„window“-Objekte für jeden der Tabs zurück, die in der aktuellen Erweiterung ausgeführt werden. Wenn windowId angegeben ist, werden nur die „window“-Objekte von Tabs zurückgegeben, die an das angegebene Fenster angehängt sind.

Parameter

  • windowId

    number optional

Ausgabe

  • Window[]

    Array globaler Fensterobjekte

getURL()

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

Verwenden Sie runtime.getURL.

Konvertiert einen relativen Pfad in einem Installationsverzeichnis für Erweiterungen in eine vollständig qualifizierte URL.

Parameter

  • Pfad

    String

    Ein Pfad zu einer Ressource in einer Erweiterung, der relativ zum Installationsverzeichnis angegeben wird.

Ausgabe

  • String

    Die vollständig qualifizierte URL der Ressource.

getViews()

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

Gibt ein Array der JavaScript-„window“-Objekte 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

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

    • Typ

      ViewType optional

      Der abzurufende Ansichtstyp. Wenn ausgelassen, werden alle Ansichten zurückgegeben (einschließlich Hintergrundseiten und ‑tabs).

    • windowId

      number optional

      Das Zeitfenster, auf das die Suche beschränkt werden soll. Wenn ausgelassen, werden alle Ansichten zurückgegeben.

Ausgabe

  • Window[]

    Array globaler Objekte

isAllowedFileSchemeAccess()

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

Ruft den Status des Zugriffs der Erweiterung auf das Schema „file://“ ab. Dies entspricht der Einstellung „Zugriff auf Datei-URLs zulassen“ für jede Erweiterung, die Nutzer über die Seite „chrome://extensions“ verwalten können.

Parameter

  • callback

    Funktion 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

    Promises 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,
): Promise<boolean>

Ruft den Status des Zugriffs der Erweiterung auf den Inkognitomodus ab. Dies entspricht der vom Nutzer gesteuerten Einstellung „Im Inkognitomodus zulassen“ für jede Erweiterung, die über die Seite „chrome://extensions“ aufgerufen werden kann.

Parameter

  • callback

    Funktion 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

    Promises 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,
): Promise<any>

Verwenden Sie runtime.sendMessage.

Sendet eine einzelne Anfrage an andere Listener in der Erweiterung. Ähnlich wie runtime.connect, aber es wird 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

    Funktion 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 Callback ohne Argumente aufgerufen und runtime.lastError wird auf die Fehlermeldung gesetzt.

Ausgabe

  • Promise<any>

    Chrome 99 und höher

    Promises 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,
): void

Legt den Wert des CGI-Parameters „ap“ fest, der in der Update-URL der Erweiterung verwendet wird. Dieser Wert wird für Erweiterungen ignoriert, die in der Chrome-Erweiterungsgalerie gehostet werden.

Parameter

  • Daten

    String

Ereignisse

onRequest

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

Verwenden Sie runtime.onMessage.

Wird ausgelöst, wenn eine Anfrage von einem Erweiterungsprozess oder einem Inhaltsscript 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