nsIConsoleService

Résumé

Le service de console est la partie principale de la Console JavaScript, fournie avec toutes les applications Mozilla. Il est utilisé pour journaliser divers messages, avertissements, et erreurs, et récupérer les messages enregistrés.

Définition de l'interface : xpcom/base/nsIConsoleService.idl

ID du contrat : @mozilla.org/consoleservice;1

Cette interface est encore en cours de développement et elle est susceptible d'être modifiée dans le futur (bug 228205).

Exemples

Journaliser un simple message

Une utilisation courante est d'enregistrer un message dans la console :

function LOG(msg) {
  var consoleService = Components.classes["@mozilla.org/consoleservice;1"]
                                 .getService(Components.interfaces.nsIConsoleService);
  consoleService.logStringMessage(msg);
}

Les méthodes de journalisation alternatives incluent Components.utils.reportError et dump().

Journaliser un message et des informations additionnelles

Pour inclure d'autres informations dans la journalisation, telles que le fichier source ou un numéro de ligne, vous devez utiliser un code plus complexe.

function myLogToConsole(aMessage, aSourceName, aSourceLine, aLineNumber, 
                        aColumnNumber, aFlags, aCategory)
{
  var consoleService = Components.classes["@mozilla.org/consoleservice;1"]
                                 .getService(Components.interfaces.nsIConsoleService);
  var scriptError = Components.classes["@mozilla.org/scripterror;1"]
                              .createInstance(Components.interfaces.nsIScriptError);
  scriptError.init(aMessage, aSourceName, aSourceLine, aLineNumber, 
                   aColumnNumber, aFlags, aCategory);
  consoleService.logMessage(scriptError);
}

• aMessage — la chaîne à journaliser. Vous devez fournir cette information.
• aSourceName — L'URL du fichier contenant l'erreur. Dans la console JavaScript, elle apparaîtra sous forme de hyperlien, il est donc intéressant d'utiliser l'URL réelle. Vous pouvez utiliser null si cela ne s'applique pas.
• aSourceLine — la ligne #aLineNumber du fichier aSourceName. C'est à vous de fournir cette ligne. Vous pouvez utiliser null si vous êtes paresseux ; cela empêchera d'afficher la ligne source dans la console JavaScript.
• aLineNumber et aColumnNumber — spécifient l'emplacement exact de l'erreur. aColumnNumber est utilisé pour dessiner la flèche pointant le caractère causant le problème.
• aFlags — un des indicateurs déclarés dans nsIScriptError. Au moment où cet article est écrit, les valeurs possibles sont : nsIScriptError.errorFlag = 0, nsIScriptError.warningFlag = 1, nsIScriptError.exceptionFlag = 2 et nsIScriptError.strictFlag = 4.
• aCategory — une chaîne indiquant quel type de code a déclenché l'envoi du message. Il existe plusieurs catégories de chaînes, mais elles ne sont pas recensées dans un endroit unique. Dans le futur, elles devraient éventuellement être listées dans <tt>nsIScriptError.idl</tt>.

Interwiki Languages Links