chrome.extension

Description

L'API chrome.extension dispose d'utilitaires qui peuvent être utilisés par n'importe quelle page d'extension. Il permet d'échanger des messages entre une extension et ses scripts de contenu, ou entre des extensions, comme décrit en détail dans Transmission de messages.

Types

ViewType

Chrome 44 et versions ultérieures

Type de vue d'extension.

Énumération

"tab"

"popup"

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 exécutées dans un processus de navigation privée. Cette dernière ne s'applique qu'aux extensions dont le paramètre incognito_behavior est défini sur "split".

Type

booléen

lastError

≤ MV2 Obsolète depuis Chrome 58

Veuillez utiliser runtime.lastError.

Défini pour la durée de vie d'un rappel si une API d'extension asynchrone a entraîné une erreur. Si aucune erreur ne s'est produite, lastError sera undefined.

Type

objet

Propriétés

  • message

    chaîne

    Description de l'erreur qui s'est produite.

Méthodes

getBackgroundPage()

Premier plan uniquement 
chrome.extension.getBackgroundPage(): Window | undefined

Renvoie l'objet JavaScript "window" pour la page d'arrière-plan exécutée dans l'extension actuelle. Renvoie la valeur "null" si l'extension n'a pas de page d'arrière-plan.

Renvoie

  • Window | undefined

getExtensionTabs()

≤ MV2 Premier plan uniquement Obsolète
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

Veuillez utiliser extension.getViews {type: "tab"}.

Renvoie un tableau des objets "window" JavaScript pour chacun des onglets exécutés dans l'extension actuelle. Si windowId est spécifié, ne renvoie que les objets "window" des onglets associés à la fenêtre spécifiée.

Paramètres

  • windowId

    number facultatif

Renvoie

  • Window[]

    Tableau d'objets de fenêtre globale

getURL()

≤ MV2 Obsolète depuis Chrome 58
chrome.extension.getURL(
  path: string,
): string

Veuillez utiliser runtime.getURL.

Convertit un chemin d'accès relatif dans 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()

Premier plan uniquement 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

Renvoie un tableau des objets "window" JavaScript pour chacune des pages exécutées dans l'extension actuelle.

Paramètres

  • fetchProperties

    object facultatif

    • tabId

      number facultatif

      Chrome 54 et versions ultérieures

      Recherchez une vue en fonction d'un ID d'onglet. Si ce champ est omis, toutes les vues sont renvoyées.

    • type

      ViewType facultatif

      Type de vue à obtenir. Si cette valeur est omise, toutes les vues (y compris les pages et les onglets en arrière-plan) sont renvoyées.

    • windowId

      number facultatif

      Fenêtre à laquelle limiter la recherche. Si ce paramètre est omis, toutes les vues sont renvoyées.

Renvoie

  • Window[]

    Tableau d'objets globaux

isAllowedFileSchemeAccess()

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

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 fichier" contrôlé par l'utilisateur pour chaque extension et accessible sur la page chrome://extensions.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booléen

      True si l'extension peut accéder au schéma "file://", ou false dans le cas contraire.

Renvoie

  • Promise<boolean>

    Chrome 99 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

isAllowedIncognitoAccess()

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

Récupère l'état de l'accès de l'extension au mode navigation privée. Cela correspond au paramètre "Autorisé en mode navigation privée" contrôlé par l'utilisateur pour chaque extension et accessible sur la page chrome://extensions.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booléen

      "True" si l'extension a accès au mode navigation privée, "false" dans le cas contraire.

Renvoie

  • Promise<boolean>

    Chrome 99 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

sendRequest()

Promise &leq; MV2 Obsolète
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

Veuillez utiliser runtime.sendMessage.

Envoie une seule requête à d'autres écouteurs de l'extension. Semblable à runtime.connect, mais 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

    chaîne facultative

    ID de l'extension à laquelle vous souhaitez vous connecter. Si cette valeur est omise, l'extension par défaut est la vôtre.

  • request

    tous

  • callback

    function facultatif

    Chrome 99 et versions ultérieures

    Le paramètre callback se présente comme suit : 

    (response: any) => void

    • réponse

      tous

      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 arguments et runtime.lastError est défini sur le message d'erreur.

Renvoie

  • Promise<any>

    Chrome 99 et versions ultérieures

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

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

&leq; MV2 Obsolète
chrome.extension.onRequest.addListener(
  callback: function,
)

Veuillez utiliser runtime.onMessage.

Déclenché lorsqu'une requête est envoyée à partir d'un processus d'extension ou d'un script de contenu.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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

    • request

      tous

    • expéditeur

      runtime.MessageSender

    • sendResponse

      fonction

      Le paramètre sendResponse se présente comme suit : 

      () => void

onRequestExternal

&leq; MV2 Obsolète
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

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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

    • request

      tous

    • expéditeur

      runtime.MessageSender

    • sendResponse

      fonction

      Le paramètre sendResponse se présente comme suit : 

      () => void