Description
L'API chrome.extension
comporte des utilitaires qui peuvent être utilisés par n'importe quelle page d'extension. Elle prend en charge l'échange de messages entre une extension et ses scripts de contenu, ou entre extensions, comme décrit en détail dans la section Transmission de messages.
Types
ViewType
Type de vue de l'extension.
Enum
"tab"
Propriétés
inIncognitoContext
Vrai pour les scripts de contenu exécutés dans des onglets de navigation privée et pour les pages d'extension s'exécutant dans un processus de navigation privée. Ce dernier s'applique uniquement aux extensions avec "split" incognito_behavior.
Type
boolean
lastError
Veuillez utiliser runtime.lastError
.
Défini pour la durée de vie d'un rappel si une API d'extension ansychronique a entraîné une erreur. Si aucune erreur ne s'est produite, lastError aura la valeur undefined
.
Type
objet
Propriétés
-
message
chaîne
Description de l'erreur qui s'est produite.
Méthodes
getBackgroundPage()
chrome.extension.getBackgroundPage()
Renvoie l'objet "window" JavaScript de la page en arrière-plan exécutée dans l'extension actuelle. Renvoie la valeur "null" si l'extension n'a pas de page en arrière-plan.
Renvoie
-
Fenêtre | non défini
getExtensionTabs()
chrome.extension.getExtensionTabs(
windowId?: number,
)
Veuillez utiliser extension.getViews
{type: "tab"}
.
Renvoie un tableau des objets JavaScript "window" pour chacun des onglets exécutés dans l'extension actuelle. Si windowId
est spécifié, renvoie uniquement les objets "window" des onglets associés à la fenêtre spécifiée.
Paramètres
-
windowId
numéro facultatif
Renvoie
-
Fenêtre[]
Tableau d'objets de fenêtre globale
getURL()
chrome.extension.getURL(
path: string,
)
Veuillez utiliser runtime.getURL
.
Convertit un chemin d'accès relatif d'un répertoire d'installation d'extension en URL complète.
Paramètres
-
chemin d'accès
chaîne
Chemin d'accès à une ressource dans une extension, exprimé par rapport à son répertoire d'installation.
Renvoie
-
chaîne
URL complète de la ressource.
getViews()
chrome.extension.getViews(
fetchProperties?: object,
)
Renvoie un tableau des objets JavaScript "window" pour chacune des pages exécutées dans l'extension actuelle.
Paramètres
-
fetchProperties
objet facultatif
-
tabId
numéro facultatif
Chrome 54 et versions ultérieuresRecherchez une vue en fonction d'un ID d'onglet. Si ce champ est omis, renvoie toutes les vues.
-
Type
ViewType facultatif
Type de vue à obtenir. En cas d'omission, renvoie toutes les vues (y compris les pages et les onglets en arrière-plan).
-
windowId
numéro facultatif
Fenêtre à laquelle limiter la recherche. Si cette valeur est omise, elle renvoie toutes les vues.
-
Renvoie
-
Fenêtre[]
Tableau d'objets globaux
isAllowedFileSchemeAccess()
chrome.extension.isAllowedFileSchemeAccess(
callback?: function,
)
Récupère l'état de l'accès de l'extension au schéma "file://". Cela correspond au paramètre "Autoriser l'accès aux URL de fichiers" contrôlé par l'utilisateur pour chaque extension, accessible sur la page chrome://extensions.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
"True" si l'extension peut accéder au schéma "file://", sinon "false".
-
Renvoie
-
Promise<boolean>
Chrome 99 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
isAllowedIncognitoAccess()
chrome.extension.isAllowedIncognitoAccess(
callback?: function,
)
Récupère l'état de l'accès de l'extension en mode navigation privée. Cela correspond au paramètre "Autorisé en navigation privée" pour chaque extension contrôlée par l'utilisateur, accessible via la page chrome://extensions.
Paramètres
-
rappel
fonction facultative
Le paramètre
callback
se présente comme suit :(isAllowedAccess: boolean) => void
-
isAllowedAccess
boolean
"True" si l'extension a accès en mode navigation privée, sinon "false".
-
Renvoie
-
Promise<boolean>
Chrome 99 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
sendRequest()
chrome.extension.sendRequest(
extensionId?: string,
request: any,
callback?: function,
)
Veuillez utiliser runtime.sendMessage
.
Envoie une requête unique à d'autres écouteurs de l'extension. Semblable à runtime.connect
, mais il n'envoie qu'une seule requête avec une réponse facultative. L'événement extension.onRequest
est déclenché sur chaque page de l'extension.
Paramètres
-
extensionId
string facultatif
ID de l'extension à laquelle vous souhaitez vous connecter. En cas d'omission, il s'agit de votre propre extension par défaut.
-
request
toutes
-
rappel
fonction facultative
Chrome 99 et versions ultérieuresLe paramètre
callback
se présente comme suit :(response: any) => void
-
réponse
toutes
Objet de réponse JSON envoyé par le gestionnaire de la requête. Si une erreur se produit lors de la connexion à l'extension, le rappel est appelé sans argument et
runtime.lastError
est défini sur le message d'erreur.
-
Renvoie
-
Promettre<tout>
Chrome 99 et versions ultérieuresLes promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.
setUpdateUrlData()
chrome.extension.setUpdateUrlData(
data: string,
)
Définit la valeur du paramètre CGI ap utilisé dans l'URL de mise à jour de l'extension. Cette valeur est ignorée pour les extensions hébergées dans la galerie d'extensions Chrome.
Paramètres
-
données
chaîne
Événements
onRequest
chrome.extension.onRequest.addListener(
callback: function,
)
Veuillez utiliser runtime.onMessage
.
Déclenché lorsqu'une requête est envoyée depuis un processus d'extension ou un script de contenu.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
request
toutes
-
expéditeur
-
sendResponse
function
Le paramètre
sendResponse
se présente comme suit :() => void
-
onRequestExternal
chrome.extension.onRequestExternal.addListener(
callback: function,
)
Veuillez utiliser runtime.onMessageExternal
.
Déclenché lorsqu'une requête est envoyée depuis une autre extension.
Paramètres
-
rappel
function
Le paramètre
callback
se présente comme suit :(request: any, sender: runtime.MessageSender, sendResponse: function) => void
-
request
toutes
-
expéditeur
-
sendResponse
function
Le paramètre
sendResponse
se présente comme suit :() => void
-