Manejo de excepciones | Web SDK

Una de las mejores prácticas a la hora de programar es escribir código que asuma y prevea que las cosas pueden salir mal. Por ejemplo, un cliente puede no estar conectado a Internet cuando intenta conectarse a una sesión.

En SDK web incluye manejadores de finalización y eventos de excepción que revelan excepciones en tiempo de ejecución.

Gestores de finalización

Para muchos métodos que se completan de forma asíncrona, el último parámetro que se pasa es una función de control de finalización. Esta función es llamada cuando el método se completa o falla. Si falla, se pasa a la función un objeto de error como parámetro.

Por ejemplo, el siguiente código llama a la función Session.connect() pasando un controlador de finalización:

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");
    }
});

Es importante implementar manejadores de finalización para ver cuando un método tiene éxito o falla. En algunos casos, puedes preguntar al usuario si existe una condición de cliente que haya causado el error. Por ejemplo, si el método error.name tiene el valor "OT_NOT_CONNECTED" cuando se llama a la propiedad Session.connect() falla, esto indica que el cliente no está conectado a la red.

Para otras condiciones de error que no son culpa del cliente, puede examinar el código de error y el mensaje para ver la naturaleza del error. Por ejemplo, cuando se llama a la función Session.connect() un código de error 1004 indica que ha intentado conectarse con un token no válido. Podría tratarse de un token caducado o que no coincide con la sesión a la que se está conectando. Compruebe la propiedad message del objeto de error para más detalles.

Métodos con gestores de finalización

Los siguientes métodos del SDK Web incluyen una función completionHandler parámetro. Para este parámetro opcional, puede pasar una función que se llama cuando el método tiene éxito o falla:

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

Compruebe el message para obtener más detalles sobre el error.

En caso de error, el code valor del error puede tener uno de los siguientes valores:

Escucha de eventos de excepción

Para detectar todos los eventos de excepción, añada un oyente de eventos para la función exception enviado por el objeto OT. Sin embargo, es más fácil reaccionar a los errores en los manejadores de finalización de métodos específicos.