chrome.extension

Beschreibung

Die chrome.extension API hat Dienstprogramme, die von jeder Erweiterungsseite verwendet werden können. Dazu gehört auch der Austausch von Nachrichten zwischen einer Erweiterung und ihren Inhaltsskripten oder zwischen Erweiterungen, wie im Abschnitt Nachrichtenübergabe ausführlich beschrieben.

Typen

ViewType

Chrome 44 und höher

Der Typ der Erweiterungsansicht.

Enum

Attribute

inIncognitoContext

„True“ für Inhaltsskripte, die auf Inkognito-Tabs ausgeführt werden, und für Erweiterungsseiten, die innerhalb eines Inkognito-Prozesses ausgeführt werden. Letzteres gilt nur für Erweiterungen, bei denen das Verhalten von „split“ für Inkognitomodus aktiviert ist.

Typ

boolean

lastError

≤ MV2 Seit Chrome 58 eingestellt

Verwenden Sie runtime.lastError.

Legt die Lebensdauer eines Callbacks fest, wenn eine asynchrone Erweiterungs-API zu einem Fehler geführt hat. Wenn kein Fehler aufgetreten ist, lautet lastError undefined.

Typ

Objekt

Attribute

  • Nachricht

    String

    Beschreibung des aufgetretenen Fehlers.

Methoden

getBackgroundPage()

Nur 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.

Rückgaben

  • Zeitraum|nicht definiert

getExtensionTabs()

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

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

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

Parameters

  • windowId

    Nummer optional

Rückgaben

  • Fenster[]

    Array mit globalen Fensterobjekten

getURL()

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

Verwenden Sie runtime.getURL.

Wandelt einen relativen Pfad innerhalb eines Installationsverzeichnisses für eine Erweiterung in eine voll qualifizierte URL um.

Parameters

  • Pfad

    String

    Ein Pfad zu einer Ressource innerhalb einer Erweiterung, der relativ zum Installationsverzeichnis ausgedrückt wird.

Rückgaben

  • String

    Die voll qualifizierte URL zur Ressource.

getViews()

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

Gibt ein Array der JavaScript-Fensterobjekte für alle Seiten zurück, die in der aktuellen Erweiterung ausgeführt werden.

Parameters

  • fetchProperties

    Objekt optional

    • tabId

      Nummer optional

      Chrome 54 und höher

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

    • Typ

      ViewType optional

      Die Art der abzurufenden Ansicht. Wenn keine Angabe gemacht wird, werden alle Ansichten zurückgegeben (einschließlich Hintergrundseiten und Tabs).

    • windowId

      Nummer optional

      Das Fenster, auf das die Suche beschränkt werden soll. Wenn keine Angabe gemacht wird, werden alle Ansichten zurückgegeben.

Rückgaben

  • Fenster[]

    Array globaler Objekte

isAllowedFileSchemeAccess()

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

Ruft den Status des Zugriffs der Erweiterung auf das Schema „file://“ ab. Sie entspricht der vom Nutzer gesteuerten Einstellung „Zugriff auf Datei-URLs zulassen“ pro Erweiterung, auf die über die Seite „chrome://extensions“ zugegriffen wird.

Parameters

  • 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“.

Rückgaben

  • Promise<boolean>

    Chrome 99 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

isAllowedIncognitoAccess()

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

Ruft den Status des Zugriffs der Erweiterung auf den Inkognitomodus ab. Sie entspricht der vom Nutzer gesteuerten Einstellung „Im Inkognitomodus zugelassen“ pro Erweiterung, die über die Seite chrome://extensions verfügbar ist.

Parameters

  • 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“.

Rückgaben

  • Promise<boolean>

    Chrome 99 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

sendRequest()

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

Verwenden Sie runtime.sendMessage.

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

Parameters

  • 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.

  • Request

    Beliebig

  • callback

    Funktion optional

    Chrome 99 oder höher

    Der Parameter callback sieht so aus: 

    (response: any)=>void

    • Antwort

      Beliebig

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

Rückgaben

  • Versprechen<any>

    Chrome 99 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Legt den Wert des ap-CGI-Parameters fest, der in der Update-URL der Erweiterung verwendet wird. Bei Erweiterungen, die in der Chrome-Erweiterungsgalerie gehostet werden, wird dieser Wert ignoriert.

Parameters

  • Daten

    String

Veranstaltungen

onRequest

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

Verwenden Sie runtime.onMessage.

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • Request

      Beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: 

      ()=>void

onRequestExternal

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

Verwenden Sie runtime.onMessageExternal.

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

Parameters

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

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

    • Request

      Beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: 

      ()=>void