chrome.extension

Description

L'API chrome.extension comporte des utilitaires qui peuvent être utilisés par n'importe quelle page d'extension. Il permet l'échange de messages entre une extension et son script de contenu, ou entre des extensions, comme décrit en détail dans la section Transmission de messages.

Types

ViewType

Chrome (version 44 ou ultérieure)

Type de vue des extensions.

Énumération

"tabulation"

"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'extensions exécutées dans un processus de navigation privée. Cette dernière ne s'applique qu'aux extensions avec "split" (séparément). incognito_behavior.

Type

booléen

lastError

<ph type="x-smartling-placeholder"></ph> &amp;leq; 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 anonyme a généré 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()

<ph type="x-smartling-placeholder"></ph> Premier plan uniquement 
chrome.extension.getBackgroundPage()

Renvoie la valeur JavaScript "window" pour 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 | indéfinie

getExtensionTabs()

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Premier plan uniquement Obsolète
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

Affiche un tableau de la fenêtre JavaScript "window" des objets pour chacun des onglets exécutés dans l'extension actuelle. Si windowId est spécifié, ne renvoie que la fenêtre objets 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 globaux

getURL()

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Obsolète depuis Chrome 58
chrome.extension.getURL(
  path: 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()

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

Affiche un tableau de la fenêtre JavaScript "window" des objets pour chacune des pages exécutées dans l'extension actuelle.

Paramètres

  • fetchProperties

    objet facultatif

    • tabId

      numéro facultatif

      Chrome (version 54 ou ultérieure)

      Recherchez 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, renvoie toutes les vues.

Renvoie

  • Fenêtre[]

    Tableau d'objets globaux

isAllowedFileSchemeAccess()

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

Récupère l'état de l'accès de l'extension à "file://" d'un schéma. Cela correspond à l'option "Autoriser l'accès aux URL de fichier" contrôlée par l'extension au niveau de chaque extension. accessible depuis la page chrome://extensions.

Paramètres

  • rappel

    function facultatif

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

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      booléen

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

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 99 ou version ultérieure

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

isAllowedIncognitoAccess()

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

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

Paramètres

  • rappel

    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, sinon "false".

Renvoie

  • Promise&lt;boolean&gt;

    Chrome 99 ou version ultérieure

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

sendRequest()

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

Veuillez utiliser runtime.sendMessage.

Envoie une requête unique aux autres écouteurs dans 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 facultatif

    ID de l'extension à laquelle vous souhaitez vous connecter. En cas d'omission, l'extension par défaut est votre propre extension.

  • request

    tous

  • rappel

    function facultatif

    Chrome 99 ou version ultérieure

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

Renvoie

  • Promesse<tous>

    Chrome 99 ou version ultérieure

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

Définit la valeur du paramètre CGI de l'application utilisé dans l'URL de mise à jour de l'extension. Cette valeur est ignorée pour les extensions hébergées dans la galerie des extensions Chrome.

Paramètres

  • données

    chaîne

Événements

onRequest

<ph type="x-smartling-placeholder"></ph> &amp;leq; MV2 Obsolète
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

    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

<ph type="x-smartling-placeholder"></ph> &amp;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

  • rappel

    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