Ejecutar, comandos

Una vez implementado el código base en la página web, puede empezar a ejecutar comandos con el SDK. No es necesario esperar a que el archivo externo (alloy.js) se cargue desde el servidor antes de ejecutar los comandos. Si el SDK no ha terminado de cargarse, los comandos se ponen en cola y el SDK los procesa lo antes posible.

Los comandos se ejecutan con la siguiente sintaxis.

alloy("commandName", options);

El commandName indica al SDK qué hacer, mientras que options son los parámetros y datos que desea pasar a un comando. Dado que las opciones disponibles dependen del comando, consulte la documentación para obtener más información sobre cada comando.

Una nota sobre las promesas

🔗 Las promesas son fundamentales para la forma en que el SDK se comunica con el código de su página web. Una promesa es una estructura de programación común y no es específica para este SDK ni siquiera para JavaScript. Una promesa actúa como proxy para un valor que no se conoce cuando se crea la promesa. Una vez conocido el valor, la promesa se "resuelve" con el valor . Las funciones del controlador se pueden asociar a una promesa, de modo que se le pueda notificar cuando la promesa se haya resuelto o cuando se haya producido un error en el proceso de resolución de la promesa. Para obtener más información sobre las promesas, lea este tutorial o cualquiera de los otros recursos de la web.

Gestión de éxito o error

Cada vez que se ejecuta un comando, se devuelve una promesa. La promesa representa la finalización final del comando. En el ejemplo siguiente, puede utilizar los métodos then y catch para determinar cuándo el comando se ha ejecutado correctamente o ha fallado.

alloy("commandName", options)
  .then(function(result) {
    // The command succeeded.
    // "value" is whatever the command returned
  })
  .catch(function(error) {
    // The command failed.
    // "error" is an error object with additional information
  });

Si saber cuándo se ejecuta correctamente el comando no es importante para usted, puede quitar la llamada then.

alloy("commandName", options)
  .catch(function(error) {
    // The command failed.
    // "error" is an error object with additional information
  });

Del mismo modo, si saber cuándo falla el comando no es importante para usted, puede quitar la llamada catch.

alloy("commandName", options)
  .then(function(result) {
    // The command succeeded.
    // "value" will be whatever the command returned
  });

Objetos de respuesta

Todas las promesas devueltas por los comandos se resuelven con un objeto result. El objeto result contendrá datos según el comando y el consentimiento del usuario. Por ejemplo, la información de la biblioteca se pasa como una propiedad del objeto results en el siguiente comando.

alloy("getLibraryInfo")
  .then(function(result) {
    console.log(result.libraryInfo.version);
  });

Consentimiento

Si un usuario no ha dado su consentimiento para un propósito particular, la promesa se resolverá; sin embargo, el objeto response solo contiene la información que se puede proporcionar en el contexto de lo que el usuario ha consentido.

En esta página