chrome.extension

Description

L'API chrome.extension dispose d'utilitaires pouvant ê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 la section Transmission de messages.

Types

ViewType

Chrome 44 ou version ultérieure

Type de vue de l'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. Ce dernier ne s'applique qu'aux extensions avec incognito_behavior de type "split".

Type

booléen

Méthodes

getBackgroundPage()

Premier plan uniquement 
chrome.extension.getBackgroundPage()

Renvoie l'objet 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 de fond.

Renvoie

  • Fenêtre | undefined

getViews()

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

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

Paramètres

  • fetchProperties

    objet facultatif

    • tabId

      number facultatif

      Chrome 54 ou version ultérieure

      Rechercher 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()

Promesse 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

Récupère l'état de l'accès de l'extension au schéma "file://". Il correspond au paramètre "Autoriser l'accès aux URL de fichier", contrôlé par l'utilisateur par extension, accessible via la page chrome://extensions.

Paramètres

  • rappel

    fonction 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 sont compatibles avec la version 3 du fichier manifeste 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 se résout avec le même type que celui transmis au rappel.

isAllowedIncognitoAccess()

Promesse 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

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

Paramètres

  • rappel

    fonction 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<boolean>

    Chrome 99 et versions ultérieures

    Les promesses sont compatibles avec la version 3 du fichier manifeste 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 se résout 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