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
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
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()
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ückgabe
-
Zeitraum | nicht definiert
getExtensionTabs()
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.
Parameter
-
windowId
Nummer optional
Rückgabe
-
Fenster[]
Array mit globalen Fensterobjekten
getURL()
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.
Parameter
-
Pfad
String
Ein Pfad zu einer Ressource innerhalb einer Erweiterung, der relativ zum Installationsverzeichnis ausgedrückt wird.
Rückgabe
-
String
Die voll qualifizierte URL zur Ressource.
getViews()
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.
Parameter
-
fetchProperties
Objekt optional
-
tabId
Nummer optional
Chrome 54 und höherSuchen 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ückgabe
-
Fenster[]
Array globaler Objekte
isAllowedFileSchemeAccess()
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.
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“.
-
Rückgabe
-
Promise<boolean>
Chrome 99 oder höherPromise-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()
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.
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“.
-
Rückgabe
-
Promise<boolean>
Chrome 99 oder höherPromise-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()
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.
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 oder höherDer 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ückgabe
-
Versprechen<any>
Chrome 99 oder höherPromise-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.
Parameter
-
daten
String
Veranstaltungen
onRequest
chrome.extension.onRequest.addListener(
callback: function,
)
Verwenden Sie runtime.onMessage
.
Wird ausgelöst, wenn eine Anfrage 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
-
Absender
-
sendResponse
Funktion
Der Parameter
sendResponse
sieht so aus:() => void
-
onRequestExternal
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
-
Absender
-
sendResponse
Funktion
Der Parameter
sendResponse
sieht so aus:() => void
-