recursal/MDN huggingface dataset:
runtime.RequestUpdateCheckStatus
================================

Résultat d'un appel à `runtime.requestUpdateCheck()`.

Type
----

Les valeurs de ce type sont des chaînes. Les valeurs possibles sont :

`"throttled"`

La mise à jour est limitée.

`"no_update"`

Aucune mise à jour n'est disponible.

`"update_available"`

Une mise à jour de l'extension est disponible.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.getPlatformInfo()
=========================

Renvoies des informations sur la plate-forme actuelle. Ceci ne peut être appelé que dans le contexte du script d'arrière-plan.

Il s'agit d'une fonction asynchrone qui renvoie une `Promise`.

Syntaxe
-------


```js
var getting = browser.runtime.getPlatformInfo();
```

### Paramètres

None.

### Valeur rentournée

Une `Promise` qui sera remplie avec une valeur `runtime.PlatformInfo` représentant la plate-forme actuelle.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Obtenez et consignez le système d'exploitation de la plateforme :


```js
function gotPlatformInfo(info) {
  console.log(info.os);
}

var gettingInfo = browser.runtime.getPlatformInfo();
gettingInfo.then(gotPlatformInfo);
```


**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.requestUpdateCheck()
============================

Vérifie de voir si un mise à jour de l'extension est disponible.

C'est une fonction asynchrone qui renvoie une `Promise`.

Syntaxe
-------


```js
var requestingCheck = browser.runtime.requestUpdateCheck();
```

### Paramètres

None.

### Valeur retournée

Une `Promise` qui sera remplie avec deux arguments :

`status`

Une valeur `runtime.RequestUpdateCheckStatus` — Le résultat de la vérification de mise à jour.

`details`Facultatif

`object`. Si le `status` est `update_available`, cela contient plus d'informations sur la mise à jour. C'est un objet contenant une simple propriété :

`version`

`string`. La version de la mise à jour.


Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Demander une mise à jour, etenregistrer la nouvelle version si elle est disponible :


```js
function onRequested(status, details) {
  console.log(status);
  if (status === "update\_available") {
    console.log(details.version);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var requestingCheck = browser.runtime.requestUpdateCheck(onRequested);
requestingCheck.then(onRequested, onError);
```


**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.onInstalled
===================

Lancé lorsque l'extension est installée pour la première fois, lorsque l'extension est mise à jour vers une nouvelle version et lorsque le navigateur est mis à jour vers une nouvelle version.

Notez que `runtime.onInstalled` n'est pas la même chose `management.onInstalled`. L'événement `runtime.onInstalled` est déclenché uniquement pour votre extension. L'événement `browser.management.onInstalled` est déclenché pour toutes les extensions.

Syntaxe
-------


```js
browser.runtime.onInstalled.addListener(listener);
browser.runtime.onInstalled.removeListener(listener);
browser.runtime.onInstalled.hasListener(listener);
```


Les événements ont trois fonctions :

`addListener(callback)`

Ajouterun écouteur à cet événement.

`removeListener(listener)`

Arrêtez d'écoutercet événement. L'argument `listener` est l'écouteur à supprimer.

`hasListener(listener)`

Vérifie si un `écouteur` est enregistré pour cet événement. Renvoie `true` s'il écoute, `false` sinon.

Syntaxe addListener
-------------------

### Paramètres

`function`

La fonction de rappel appelée lorsque cet événement se produit. La fonction recevra les arguments suivants :

`details`

Un objet avec les propriétés suivantes :

`id`Facultatif

`string`. L'ID de l'extension de module partagé importé mise à jour. Ceci n'est présent que si la valeur de `raison` est `shared_module_update`.

`previousVersion`Facultatif

`string`. La version précédente de l'extension vient d'être mise à jour. Ceci n'est pas présent si la valeur de `raison` est `mise à jour`.

`reason`

Une valeur `runtime.OnInstalledReason`, indiquant la raison pour laquelle cet événement est distribué.

`temporary`

`boolean`. Vrai si le module complémentaire a été installé temporairement. Par exemple, en utilisant la page "about:debugging" dans Firefox ou en utilisant web-ext run. Sinon faux.


Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Lorsque l'extensin est installé, connectez-vous à la raison de l'installon et ouvrez https://www.reddit.com/r/CatGifs/:


```js
function handleInstalled(details) {
  console.log(details.reason);
  browser.tabs.create({
    url: "http://chilloutandwatchsomecatgifs.com/",
  });
}

browser.runtime.onInstalled.addListener(handleInstalled);
```

### Example extensions

* runtime-examples

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.getURL()
================

Etant donné un chemin relatif de manifest.json à une ressource empaquetée avec l'extension, renvoyez une URL complète.Cette fonction ne vérifie pas que la ressource existe réellement à cette URL.Syntaxe
-------


```js
browser.runtime.getURL(
  path, // string
);
```

### Paramètres

`path`

`string`. Un chemin relatif de manifest.json à une ressource empaquetée avec l'extension.

### Valeur retournée

`string`. L'URL complète de la ressource.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Etant donné un fichier empaqueté avec l'extension "beasts/frog.html", obtenez l'URL complète comme ceci :


```js
var fullURL = browser.runtime.getURL("beasts/frog.html");
console.log(fullURL);
// Returns something like:
// moz-extension://2c127fa4-62c7-7e4f-90e5-472b45eecfdc/beasts/frog.html
```

### Example extensions

* devtools-panels
* find-across-tabs
* permissions

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.id
==========

L'ID de l'extension

Syntaxe
-------


```js
var myAddonId = browser.runtime.id;
```

### Value

Une `chaîne` représentant l'ID du module complémentaire. Si l'extension a spécifié un ID dans la clé manifest.json de ses applications, `runtime.id` contiendra la valeur. SInon `runtime.id` contiendra l'ID généré pour l'extension.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.
runtime.lastError
=================

Cette valeur est utilisée pour signaler un message d'erreur provenant d'une API asynchrone, lorsque l'API asynchrone reçoit un rappel. Cela est utile pour les extensions qui utilisent la valeur basée sur le rappel des API WebExtension.Vpous n'avez pas besoin de vérifier cette propriété si vous utilisez la version basée sur la promesse des API : à la place, passez un gestionnaire d'erreurs à la promesse :

```js
var gettingCookies = browser.cookies.getAll();
gettingCookies.then(onGot, onError);
```


La propriété `runtime.lastError` est définie lorsqu'une fonction asynchrone a une condition d'erreur qu'elle doit signaler à son appelant.

Si vous applez une fonction asynchrone qui veut définir `lastError`, vous devez vérifier l'erreur lorsque vous gérez le résultat de la fonction. Si `lastError` a été défini et que vous ne cochez pas dans la fonction de rappel, une erreur sera générée.

Syntaxe
-------


```js
var myError = browser.runtime.lastError; // null or Error object
```

### Valeur

Un objet Error représentant une erreur. La propriété `message` est un `string` avec une description lisible par l'utilisateur de l'erreur. Si `lastError` n'a pas été défini, la valeur est `null`.

Examples
--------

Définir un cookie, utiliser pour enregistrer le nouveau cookie ou signaler une erreur :


```js
function logCookie(c) {
  if (browser.runtime.lastError) {
    console.error(browser.runtime.lastError);
  } else {
    console.log(c);
  }
}

browser.cookies.set({ url: "https://developer.mozilla.org/" }, logCookie);
```


La même chose, mais en utilisant une promesse de gérer le résultat de `setCookie()`:


```js
function logCookie(c) {
  console.log(c);
}

function logError(e) {
  console.error(e);
}

var setCookie = browser.cookies.set({ url: "https://developer.mozilla.org/" });

setCookie.then(logCookie, logError);
```


**Note :** `runtime.lastError` est un alias pour `extension.lastError`: Ils sont ensemble, et la vérification de l'un fonctionnera.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

### Example extensions

* menu-demo

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.connectNative()
=======================

Connecte l'extension à une appplication native sur l'ordinateur de l'utilisateur.Cela prend le nom d'une application native en tant que paramètre. Il démarre l'application native et retourne un objet `runtime.Port` à l'appelant.L'appelant peut utiliser le `Port` pour échanger des messages avec l'application native utilisant `Port.postMessage()` et `port.onMessage`.L'application native s'exécute jusqu'à ce qu'elle se termine, ou l'appelant appelle `Port.disconnect()`, ou la page qui a créé le `Port` est détruite. Une fois le `Port` est déconnecté, le navigateur mettra quelques secondes à se terminer pour quitter le processus, puis le désactiver s'il ne s'est pas arrêté.
Pour plus d'informations, voir messagerie native.

Syntaxe
-------


```js
var port = browser.runtime.connectNative(
  application, // string
);
```

### Paramètres

`application`

`string`. Le nom de l'application native à laquelle se connecter. Cela doit correspondre à la propriété "name" dans le fichier manifest de l'application native.

### Valeur retournée

Un objet `runtime.Port`. Le port que l'appelant peut utiliser pour échanger des messages avec l'application native.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Cet exemple se connecte à l'appplication native "ping\_pong" et commence à en écouter les messages. Il envoie également un message à l'application native lorsque l'utilisateur clique sur l'icône d'une action du navigateur :


```js
/\*
On startup, connect to the "ping\_pong" app.
\*/
var port = browser.runtime.connectNative("ping\_pong");

/\*
Listen for messages from the app.
\*/
port.onMessage.addListener((response) => {
  console.log("Received: " + response);
});

/\*
On a click on the browser action, send the app a message.
\*/
browser.browserAction.onClicked.addListener(() => {
  console.log("Sending: ping");
  port.postMessage("ping");
});
```

### Example extensions

* native-messaging

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.PlatformInfo
====================

Un objet contenant des informations sur la plate-forme actuelle.

Type
----

Les valeurs de ce type sont des objets qui contiennent les propriétés suivantes:

`os`

`runtime.PlatformOs`. Le système d'exploitation de la plateforme.

`arch`

`runtime.PlatformArch`. L'architecture du processeur de la plateforme.

`nacl_arch`

`runtime.PlatformNaclArch`. L'architecture du client natif Cela peut être différent de `arch` sur certaines plates-formes.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.onRestartRequired
=========================

Lancé lorsqu'une application ou le périphérique sur lequel elle s'exécute doit être redémarré. L'application devrait fermer toutes ses fenêtres dans les meilleurs délais pour permettre le redémarrage. Si l'application ne fait rien, un redémarrage sera appliqué après une période de grâce de 24 heures. Actuellement, cet événement est uniquement déclenché pour les applications de kiosque ChromeOS.

Syntaxe
-------


```js
browser.runtime.onRestartRequired.addListener(listener);
browser.runtime.onRestartRequired.removeListener(listener);
browser.runtime.onRestartRequired.hasListener(listener);
```


Les événements ont trois fonctions :

`addListener(callback)`

Ajouter un écouteur à cet événement.

`removeListener(listener)`

Arrêtez d'écouter cet événement. L'argument `listener` est l'écouteur à supprimer.

`hasListener(listener)`

Vérifie si un `listener` est enregistré pour cet événement. Renvoie `true` s'il écoute, `false` sinon.

Syntaxe addListener
-------------------

### Paramètres

`fonction`

Une fonction de rappel qui sera appelée lorsque cet événement se produira. La fonction recevra les arguments suivants :

`raison`

Une valeur `runtime.OnRestartRequiredReason` — La raison pour laquelle l'événemtn est envoyé.


Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.onConnect
=================

Lancé quand une connexion est établie avec un processus d'extension ou un script de contenu.

Syntaxe
-------


```js
browser.runtime.onConnect.addListener(listener);
browser.runtime.onConnect.removeListener(listener);
browser.runtime.onConnect.hasListener(listener);
```


Les événements ont trois fonctions :

`addListener(callback)`

Ajoute un écouteur à cet événement.

`removeListener(listener)`

Arrêtez d'écouter cet événement. L'argument de l'`écouteur` est l'écouteur à supprimer.

`hasListener(listener)`

Vérifie si un `écouteur` est enregistré pour cet événement. Renvoie `true` s'il écoute, sinon `false`.

Syntaxe addListener
-------------------

### Paramètres

`fonction`

Une fonction de rappel qui sera appelée lorsque cet événement se produira. La fonction recevra les arguments suivants:

`port`

Un objet `runtime.Port` connectant le script courant à l'autre contexte auquel il se connecte.


Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Ce script de contenu :

* Se connecte au script d'arrière-plan et stocke le `Port` dans une variable `myPort`
* Ecoute les messages sur `myPort`, et les enregistre
* Envoie des messages au script d'arrière-plan, en utilisant `myPort`, lorsque l'utilisateur clique sur le document


```js
// content-script.js

var myPort = browser.runtime.connect({ name: "port-from-cs" });
myPort.postMessage({ greeting: "hello from content script" });

myPort.onMessage.addListener(function (m) {
  console.log("In content script, received message from background script: ");
  console.log(m.greeting);
});

document.body.addEventListener("click", function () {
  myPort.postMessage({ greeting: "they clicked the page!" });
});
```


Le script d'arrière-plan correspondant :

* Ecoute les tentatives de connexion de script de contenu
* Quand il reçoit une tentative de connexion :
    + Stocke le port dans une variable nommée `portFromCS`
    + Envoie un message au script de contenu en utilisant le port
    + Commence à écouter les messages reçus sur le port et les enregistre
* Envoie des messages au script de contenu, en utilisant `portFromCS`, quand l'utilisateur clique sur l'action du navigateur de l'extension


```js
// background-script.js

var portFromCS;

function connected(p) {
  portFromCS = p;
  portFromCS.postMessage({ greeting: "hi there content script!" });
  portFromCS.onMessage.addListener(function (m) {
    console.log("In background script, received message from content script");
    console.log(m.greeting);
  });
}

browser.runtime.onConnect.addListener(connected);

browser.browserAction.onClicked.addListener(function () {
  portFromCS.postMessage({ greeting: "they clicked the button!" });
});
```


**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.openOptionsPage()
=========================

Si votre extension a défini une page d'options, cette méthode l'ouvre.
C'est une fonction asynchrone qui renvoie une `Promise`.

Syntaxe
-------


```js
var openingPage = browser.runtime.openOptionsPage();
```

### Paramètres

None.

### Valeur retournée

Une `Promise` qui sera remplie sans argument lorsque la page d'options a été créée avec succés, ou rejetée avec un message d'erreur si l'opération a échoué.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Ouvrez une page d'options lorsque l'utilisateur clique sur l'icône d'une action du navigateur :


```js
function onOpened() {
  console.log(`Options page opened`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var opening = browser.runtime.openOptionsPage();
opening.then(onOpened, onError);
```

### Example extensions

* favourite-colour

**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.onSuspendCanceled
=========================

Envoyé après `runtime.onSuspend` pour indiquer que l'application ne sera pas déchargée après tout.

Syntaxe
-------


```js
browser.runtime.onSuspendCanceled.addListener(listener);
browser.runtime.onSuspendCanceled.removeListener(listener);
browser.runtime.onSuspendCanceled.hasListener(listener);
```


Les événements ont trois fonctions :

`addListener(callback)`

Ajouter un écouteur à cet événement.

`removeListener(listener)`

Arrêtez d'écouter cet événement. L'argument `listener` est un écouteur à suppriimer.

`hasListener(listener)`

Vérifie si un `écouteur` est enregistré pour cet événement. Retourne `true` s'il écoute, sinon `false`.

Syntaxe addListener
-------------------

### Paramètres

`callback`

Fonction qui sera appelée lorsque cet événement se produit.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Exemples
--------

Ecoutez les événements `SuspendCanceled` :


```js
function handleSuspendCanceled() {
  console.log("Suspend canceled");
}

browser.runtime.onSuspendCanceled.addListener(handleSuspendCanceled);
```


**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
runtime.onStartup
=================

Lancé quand un profil ayant cette extension installée démarre une session. Cet événement n'est pas déclenché lorsqu'une navigation privée / profil privé est démarré, même si cette extension fonctionne en mode de navigation privée 'split'.

Syntaxe
-------


```js
browser.runtime.onStartup.addListener(listener);
browser.runtime.onStartup.removeListener(listener);
browser.runtime.onStartup.hasListener(listener);
```

### Fonctions des événements

Les événements ont trois fonctions :

`addListener(callback)`

Ajoute un écouteur à écouteur.

`removeListener(listener)`

Arrête d'écouter cet événement. L'argument `listener` est l'écouteur à supprimer.

`hasListener(listener)`

Vérifie si un `écouteur` est enregistré pour cet événement. Renvoie `true` s'il écoute, sinon `false`.

### Parameters

`callback`

Une fonction qui sera appelée lorsque cet événement se produit.

Exemples
--------

Ouvre http://chilloutandwatchsomecatgifs.com/ quand le navigateur démarre :


```js
function handleStartup() {
  browser.tabs.create({
    url: "http://chilloutandwatchsomecatgifs.com/",
  });
}

browser.runtime.onStartup.addListener(handleStartup);
```


**Note :**

Cette API est basée sur l'API Chromium `chrome.runtime`. Cette documentation est dérivée de `runtime.json` dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.