Gestion des exceptions | Web SDK

Une bonne pratique en matière de programmation consiste à écrire un code qui suppose et anticipe que les choses vont mal se passer. Par exemple, un client peut ne pas être connecté à Internet lorsqu'il essaie de se connecter à une session.

Les SDK Web comprend des gestionnaires d'achèvement et des événements d'exception qui révèlent les exceptions au moment de l'exécution.

Gestionnaires d'achèvement

Pour de nombreuses méthodes qui se terminent de manière asynchrone, le dernier paramètre que vous passez est une fonction de gestion de l'achèvement. Cette fonction est appelée lorsque la méthode se termine ou échoue. En cas d'échec, un objet d'erreur est transmis à la fonction en tant que paramètre.

Par exemple, le code suivant appelle la fonction Session.connect() en transmettant un gestionnaire d'achèvement :

var session = OT.initSession(apiKey, session);
session.connect(token, function (error) {
    if (error) {
    console.log("Failed to connect: ", error.message);
    if (error.name === "OT_NOT_CONNECTED") {
        alert("You are not connected to the internet. Check your network connection.");
    }
    } else {
    console.log("Connected");
    }
});

Il est important d'implémenter des gestionnaires d'achèvement pour savoir quand une méthode réussit ou échoue. Dans certains cas, vous pouvez demander à l'utilisateur si une condition du client est à l'origine de l'erreur. Par exemple, si la méthode error.name est définie sur "OT_NOT_CONNECTED" lors de l'appel de la fonction Session.connect() échoue, cela indique que le client n'est pas connecté au réseau.

Pour les autres conditions d'erreur qui ne sont pas imputables au client, vous pouvez examiner le code d'erreur et le message pour connaître la nature de l'erreur. Par exemple, lors de l'appel de la fonction Session.connect() échoue, le code d'erreur 1004 indique que vous avez essayé de vous connecter avec un jeton non valide. Il peut s'agir d'un jeton qui a expiré ou qui ne correspond pas à la session à laquelle vous vous connectez. Pour plus de détails, consultez la propriété message de l'objet d'erreur.

Méthodes avec gestionnaires d'achèvement

Les méthodes suivantes du SDK Web comprennent une fonction completionHandler paramètre. Pour ce paramètre facultatif, vous pouvez passer une fonction qui est appelée lorsque la méthode réussit ou échoue :

• Session.forceDisconnect()
• Session.forceUnpublish()
• Session.connect()
• Session.publish()
• Session.signal()
• Session.subscribe()
• OT.initPublisher()

Vérifier le message pour plus de détails sur l'erreur.

En cas d'erreur, le code de la valeur de la error peut prendre l'une des valeurs suivantes :

Écoute des événements d'exception

Pour détecter tous les événements d'exception, ajoutez un écouteur d'événements pour la fonction exception déclenché par l'objet OT. Toutefois, il est plus facile de réagir aux erreurs dans des gestionnaires d'achèvement pour des méthodes spécifiques.