chrome.extension

Beschreibung

Die chrome.extension API enthält Dienstprogramme, die von jeder Erweiterungsseite verwendet werden können. Diese Funktion unterstützt den Austausch von Nachrichten zwischen einer Erweiterung und ihren Inhaltsskripten oder zwischen Erweiterungen. Weitere Informationen hierzu finden Sie unter Nachrichtenweitergabe.

Typen

ViewType

Chrome (ab Version 44)

Der Typ der Erweiterungsansicht.

Enum

"Tab"

"Popup"

Attribute

inIncognitoContext

True für Inhaltsskripte, die in Inkognito-Tabs ausgeführt werden, und für Erweiterungsseiten, die in einem Inkognito-Prozess ausgeführt werden. Letzteres gilt nur für Erweiterungen mit „split“. Inkognito-Verhalten.

Typ

boolean

lastError

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Eingestellt seit Chrome 58

Bitte verwende runtime.lastError.

Wird für die Lebensdauer eines Callbacks festgelegt, wenn eine synchrone 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()

<ph type="x-smartling-placeholder"></ph> Nur Vordergrund 
chrome.extension.getBackgroundPage()

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

Gibt Folgendes zurück:

  • Fenster | nicht definiert

getExtensionTabs()

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Nur Vordergrund Eingestellt
chrome.extension.getExtensionTabs(
  windowId?: number,
)

Bitte verwende extension.getViews {type: "tab"}.

Gibt ein Array des JavaScript-Fensters zurück -Objekte für jeden Tab, der in der aktuellen Erweiterung ausgeführt wird. Wenn windowId angegeben ist, wird nur das Fenster zurückgegeben. Objekte von Tabs, die dem angegebenen Fenster zugeordnet sind.

Parameter

  • windowId

    Zahl optional

Gibt Folgendes zurück:

  • Fenster[]

    Array globaler Fensterobjekte

getURL()

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Seit Chrome 58 eingestellt
chrome.extension.getURL(
  path: string,
)

Bitte verwende runtime.getURL.

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

Parameter

  • Pfad

    String

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

Gibt Folgendes zurück:

  • String

    Die voll qualifizierte URL zur Ressource.

getViews()

<ph type="x-smartling-placeholder"></ph> Nur Vordergrund 
chrome.extension.getViews(
  fetchProperties?: object,
)

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

Parameter

  • fetchProperties

    Objekt optional

    • tabId

      Zahl 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 Typ der abzurufenden Ansicht. Wenn nichts angegeben ist, werden alle Ansichten zurückgegeben (einschließlich Hintergrundseiten und Tabs).

    • windowId

      Zahl optional

      Das Fenster, auf das die Suche beschränkt werden soll. Wenn nichts angegeben ist, werden alle Ansichten zurückgegeben.

Gibt Folgendes zurück:

  • Fenster[]

    Array globaler Objekte

isAllowedFileSchemeAccess()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Ruft den Status des Zugriffs der Erweiterung auf „file://“ ab . Dies entspricht der vom Nutzer gesteuerten Einstellung „Zugriff auf Datei-URLs erlauben“ pro Erweiterung auf der Seite „chrome://extensions“.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

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

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 99 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

isAllowedIncognitoAccess()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

Ruft den Status des Zugriffs der Erweiterung auf den Inkognitomodus ab. Das entspricht der vom Nutzer verwalteten Pro-Erweiterung „Im Inkognitomodus zugelassen“ auf der Seite „chrome://extensions“.

Parameter

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      boolean

      Der Wert "True", wenn die Erweiterung Zugriff auf den Inkognitomodus hat, andernfalls "False".

Gibt Folgendes zurück:

  • Promise&lt;boolean&gt;

    Chrome 99 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

sendRequest()

<ph type="x-smartling-placeholder"></ph> Versprechen &amp;leq; MV2 Eingestellt
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

Bitte verwende runtime.sendMessage.

Sendet eine einzelne Anfrage an andere Listener innerhalb der Erweiterung. Ähnlich wie runtime.connect, sendet jedoch nur eine einzelne Anfrage mit einer optionalen Antwort. 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: <ph type="x-smartling-placeholder"></ph>

    (response: any) => void

    • Antwort

      beliebig

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

Gibt Folgendes zurück:

  • Versprechen<beliebig>

    Chrome 99 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das 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.

Parameter

  • Daten

    String

Ereignisse

onRequest

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Eingestellt
chrome.extension.onRequest.addListener(
  callback: function,
)

Bitte verwende runtime.onMessage.

Wird ausgelöst, wenn eine Anfrage von einem Erweiterungsprozess oder einem Content-Skript gesendet wird.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

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

    • Anfrage

      beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: <ph type="x-smartling-placeholder"></ph>

      () => void

onRequestExternal

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Eingestellt
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

Bitte verwende runtime.onMessageExternal.

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

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

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

    • Anfrage

      beliebig

    • sendResponse

      Funktion

      Der Parameter sendResponse sieht so aus: <ph type="x-smartling-placeholder"></ph>

      () => void