Ce module fournit des informations sur votre extension et l'environnement dans lequel elle fonctionne.

Il fournit également des API de messagerie vous permettant de:

  • Communiquer entre les différentes parties de votre extension.
  • Communiquer avec d'autres extensions.
  • Communiquer avec les applications natives.

Types

runtime.Port
Représente une extrémité d'une connexion entre deux contextes spécifiques, qui peut être utilisée pour échanger des messages.
runtime.MessageSender

Contient des informations sur l'expéditeur d'un message ou d'une demande de connexion.

runtime.PlatformOs
Identifie le système d'exploitation du navigateur.
runtime.PlatformArch
Identifie l'architecture du processeur du navigateur.
runtime.PlatformInfo
Contient des informations sur la plate-forme utilisée par le navigateur.
runtime.RequestUpdateCheckStatus
Résultat d'un appel à runtime.requestUpdateCheck().
runtime.OnInstalledReason
La raison pour laquelle l'événement runtime.onInstalled est en cours d'envoi.
runtime.OnRestartRequiredReason
La raison pour laquelle l'événement runtime.onRestartRequired est en cours d'expédition.

Propriétés

runtime.lastError
Cette valeur est définie lorsqu'une fonction asynchrone a une condition d'erreur qu'elle doit signaler à son appelant
runtime.id
L'ID de l'extension

Fonctions

runtime.getBackgroundPage()
Récupère l'objet Window pour la page d'arrière-plan qui s'exécute dans l'extension en cours.
runtime.openOptionsPage()

Ouvre une page d'options de votre extension.

runtime.getManifest()
Obtient le fichier manifest.json complet,  sérialisé en tant qu'objet.
runtime.getURL()
Etant donné un chemin relatif de manifest.json à une ressource empaquetée avec l'extension, renvoie une URL entièrement qualifiée.
runtime.setUninstallURL()
Définit une URL à visiter lorsque l'extension est désinstallée.
runtime.reload()
Recharge l'extension.
runtime.requestUpdateCheck()
Vérifie les mises à jour de cette extension.
runtime.connect()
Établit une connexion d'un script de contenu au processus d'extension principal ou d'une extension à une extension différente.
runtime.connectNative()
Connecte l'extension à une application native sur l'ordinateur de l'utilisateur.
runtime.sendMessage()
Envoie un seul message aux écouteurs d'événement dans votre extension ou une extension différente. Similaire à  runtime.connect mais n'envoie qu'un seul message, avec une réponse facultative.
runtime.sendNativeMessage()
Envoie un seul message d'une extension à une application native.
runtime.getPlatformInfo()
Renvoie des informations sur la plate-forme actuelle.
runtime.getBrowserInfo()
Renvoie des informations sur le navigateur dans lequel cette extension est installée.
runtime.getPackageDirectoryEntry()
Renvoie un DirectoryEntry pour le répertoire du package.

Evénements

runtime.onStartup
Lancé lorsqu'un premier profil a cette extension installée. Cet événement n'est pas déclenché lorsqu'un profil de navigation privée est démarré.
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.
runtime.onSuspend
Envoyé sur la page de l'événement juste avant le déchargement de l'extension. Cela donne à l'extension l'opportunité de faire un peu de nettoyage.
runtime.onSuspendCanceled
Envoyé après runtime.onSuspend pour indiquer que l'extension ne sera pas déchargée après tout.
runtime.onUpdateAvailable
Lancé lorsqu'une mise à jour est disponible, mais n'est pas installé immédiatement car l'extension est en cours d'exécution.
runtime.onBrowserUpdateAvailable
Lancé lorsqu'une mise à jour pour le navigateur est disponible, mais n'est pas installée immédiatement car un redémarrage du navigateur est requis.
runtime.onConnect
Lancé lorsqu'une connexion est établie avec un processus d'extension ou un script de contenu.
runtime.onConnectExternal
Lancé lorsqu'une connexion est établie avec une autre extension.
runtime.onMessage
Lancé lorsqu'un message est envoyé par un processus d'extension ou un script de contenu.
runtime.onMessageExternal
Lancé lorsqu'un message est envoyé depuis un autre poste. Ne peut pas être utilisé dans un script de contenu.
runtime.onRestartRequired
Lancé lorsque le périphérique doit être redémarré.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
MessageSender261445 *48 *15
OnInstalledReason Oui *14 *4548 Oui *
OnRestartRequiredReason Oui Non4548 Oui
PlatformArch Oui Non4548 Oui
PlatformInfo Oui Non4548 Oui
PlatformNaclArch Oui Non4548 Oui
PlatformOs Oui Non4548 Oui
Port2615454815
RequestUpdateCheckStatus Oui Non Non Non Oui
connect2614454815
connectNative291550 Non16
getBackgroundPage221445 *48 *15
getBrowserInfo Non Non5151 Non
getManifest2214454815
getPackageDirectoryEntry29 Non Non Non16
getPlatformInfo29 Non454816
getURL2214454815
id2214454815
lastError Oui *144748 Oui *
onBrowserUpdateAvailable27 Non Non Non15
onConnect2614454815
onConnectExternal26 Non545415
onInstalled221452 *52 *15
onMessage2614454815
onMessageExternal26 Non545415
onRestartRequired29 Non Non Non16
onStartup23 Non525215
onSuspend22 Non Non Non15
onSuspendCanceled22 Non Non Non15
onUpdateAvailable25 Non515115
openOptionsPage42 Non485729
reload2515515115
requestUpdateCheck25 Non Non Non15
sendMessage2614 *454815
sendNativeMessage291550 Non16
setUninstallURL4115474828

 
Remerciements :

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.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,