5.7.3.7 displayError

5.7.3.7.1 Déclenchement

Un message d'erreur est présenté à l'utilisateur. Ce message peut avoir différente causes (plus de réseau, contrainte non respectée, etc.)

5.7.3.7.2 Éléments passés au callback

event

objet événement standard de jQuery,

documentObject

un objet document décrivant le document courant.

message

objet décrivant le message. L'objet contient les propriétés suivantes :

title

titre du message,

errorCode

code d'erreur du message. Les plus courants sont :

• offline : requête impossible pour cause de réseau,
• CRUD0211 : un attribut n'est pas au bon format et n'a pas pu être sauvé,
• CRUD0212 : une contrainte n'est pas respectée.

Les autres identifiants d'erreurs peuvent être trouvés dans la documentation de l'API HTTP.

message

contenu textuel du message.

htmlMessage (optionnel)

contenu html du message.

L'élément message peut-être modifié dans le callback de l'événement.

5.7.3.7.3 Annulable

Oui. Dans ce cas le message n'est pas affiché.

5.7.3.7.4 Exemple

Cet exemple modifie le message avant son affichage.

window.dcp.document.documentController("addEventListener",
    "displayError",
    {
        "name": "changeErrorMessage"
    },
    function changeErrorMessage(event, documentObject, message) {
        if (message.errorCode === "offline") {
            message.message = "Pas de serveur";
        }
    }
);

Cet exemple annule le message d'erreur et le remplace par une alert.

window.dcp.document.documentController("addEventListener",
    "displayError",
    {
        "name": "changeDisplayError"
    },
    function changeDisplayError(event, documentObject, message) {
        event.preventDefault();
        alert(message.message);
    }
);