Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

runtime

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 :

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 plateforme sur laquelle le navigateur s'exécute.

runtime.PlatformNaclArch

Valeur d'énumération obsolète représentant l'architecture Google Native Client. Envisagez de migrer vers PlatformArch, qui est pris en charge par Safari et Mozilla, représente l'architecture réelle du processeur et fournit des informations correctes sur le nombre de bits sur ARM.

runtime.RequestUpdateCheckStatus

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

runtime.OnInstalledReason

Raison pour laquelle l'évènement runtime.onInstalled est déclenché.

runtime.OnPerformanceWarningCategory

Catégorie de l'avertissement qui a déclenché l'évènement runtime.onPerformanceWarning.

runtime.OnPerformanceWarningSeverity

Gravité de l'avertissement qui a déclenché l'évènement runtime.onPerformanceWarning.

runtime.OnRestartRequiredReason

Raison pour laquelle l'évènement runtime.onRestartRequired est déclenché.

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 correspondant à la page d'arrière-plan s'exécutant au sein de l'extension actuelle.

runtime.getDocumentId()

Retourne l'ID du document de n'importe quel élément global de la fenêtre ou de cadre.

runtime.openOptionsPage()

Ouvre la page d'options de votre extension.

runtime.getContexts()

Obtient des détails sur les contextes associés à l'extension.

runtime.getFrameId()

Obtient l'identifiant de cadre de n'importe quel élément global de la fenêtre ou de cadre.

runtime.getManifest()

Récupère une représentation sous forme d'objet du fichier manifest.json complet.

runtime.getURL()

À partir d'un chemin relatif indiqué dans le fichier manifest.json vers une ressource incluse dans l'extension, retourne une URL complète.

runtime.getVersion()

Obtient la chaîne de caractères correspondant à la version de l'extension à partir de la clé version du fichier manifest.json. La version retournée peut différer de la chaîne de caractères présente dans le fichier, car le navigateur peut l'analyser et la sérialiser.

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 vers le processus principal de l'extension, ou d'une extension vers une autre extension.

runtime.connectNative()

Connecte l'extension à une application native sur l'ordinateur de l'utilisateur·ice.

runtime.sendMessage()

Envoie un message aux écouteurs d'évènements au sein de votre extension ou d'une autre extension. Semblable à runtime.connect, mais n'envoie qu'un seul message, avec une réponse optionnelle.

runtime.sendNativeMessage()

Envoie un message depuis une extension vers une application native.

runtime.getPlatformInfo()

Retourne des informations sur la plateforme actuelle.

runtime.getBrowserInfo()

Retourne des informations sur le navigateur dans lequel cette extension est installée.

runtime.getPackageDirectoryEntry()

Retourne une instance DirectoryEntry correspondant au répertoire du paquet.

Évènements

runtime.onStartup

Déclenché lorsque le profil qui a cette extension installée démarre pour la première fois. Cet évènement n'est pas déclenché lorsque un profil de navigation privée est démarré.

runtime.onInstalled

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

runtime.onSuspend

Envoyé à la page d'évènements juste avant que l'extension ne soit déchargée. Cela donne à l'extension l'occasion de faire un peu de nettoyage.

runtime.onSuspendCanceled

Envoyé après runtime.onSuspend pour indiquer que l'extension n'est finalement pas déchargée.

runtime.onUpdateAvailable

Déclenché lorsqu'une mise à jour est disponible, mais n'est pas installée immédiatement parce que l'extension est actuellement en cours d'exécution.

runtime.onBrowserUpdateAvailable

Déclenché lorsqu'une mise à jour du navigateur est disponible, mais n'est pas installée immédiatement parce qu'un redémarrage du navigateur est requis.

runtime.onConnect

Déclenché lorsqu'une connexion est établie avec soit un processus d'extension, soit un script de contenu.

runtime.onConnectExternal

Déclenché lorsqu'une connexion est établie avec une autre extension.

runtime.onUserScriptConnect

Déclenché lorsqu'une connexion est établie avec un script utilisateur·ice enregistré par l'extension.

runtime.onMessage

Déclenché lorsqu'un message est envoyé depuis soit un processus d'extension, soit un script de contenu.

runtime.onMessageExternal

Déclenché lorsqu'un message est envoyé depuis une autre extension. Ne peut pas être utilisé dans un script de contenu.

runtime.onUserScriptMessage

Déclenché lorsqu'un message est envoyé depuis un script utilisateur·ice enregistré par l'extension.

runtime.onPerformanceWarning

Déclenché lorsqu'un problème de performance d'exécution est détecté pour l'extension.

runtime.onRestartRequired

Déclenché lorsque l'appareil doit être redémarré.

Exemples d'extensions

Compatibilité des navigateurs

Note : Cette API est basée sur l'API Chromium chrome.runtime (angl.). Cette documentation est dérivée de runtime.json (angl.) dans le code de Chromium code.