Executar comandos

Depois que o código base tiver sido implementado em sua página da Web, você poderá começar a executar comandos com o SDK. Não é necessário aguardar o arquivo externo (alloy.js) a ser carregada do servidor antes de executar comandos. Se o SDK não tiver terminado de carregar, os comandos serão enfileirados e processados pelo SDK o mais rápido possível.

Os comandos são executados usando a sintaxe a seguir.

alloy("commandName", options);

O commandName informa o SDK sobre o que fazer enquanto options são os parâmetros e dados que você gostaria de passar em um comando. Como as opções disponíveis dependem do comando, consulte a documentação para obter mais detalhes sobre cada comando.

Uma nota sobre promessas

Promessas são fundamentais para a forma como o SDK se comunica com o código em sua página da Web. Uma promessa é uma estrutura de programação comum e não é específica para esse SDK ou até mesmo para JavaScript. Uma promessa atua como um proxy para um valor que não é conhecido quando a promessa é criada. Quando o valor for conhecido, a promessa será "resolvida" com o valor . As funções do manipulador podem ser associadas a uma promessa, para que você possa ser notificado quando a promessa tiver sido resolvida ou quando um erro tiver ocorrido no processo de resolver a promessa. Para saber mais sobre promessas, leia este tutorial ou qualquer outro recurso na Web.

Manipulação de sucesso ou falha

Cada vez que um comando é executado, uma promessa é retornada. A promessa representa a conclusão final do comando. No exemplo abaixo, você pode usar then e catch métodos para determinar quando o comando foi bem-sucedido ou falhou.

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

Se não for importante saber quando o comando foi bem-sucedido, você poderá remover a variável then chame.

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

Da mesma forma, se você não souber quando o comando falhar não for importante, poderá remover a variável catch chame.

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

Objetos de resposta

Todas as promessas retornadas de comandos são resolvidas com uma result objeto. O objeto de resultado conterá dados dependendo do comando e do consentimento do usuário. Por exemplo, as informações da biblioteca são passadas como uma propriedade do objeto de resultados no comando a seguir.

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

Consentimento

Se um usuário não tiver dado seu consentimento para um propósito específico, a promessa ainda será resolvida. no entanto, o objeto response conterá apenas as informações que podem ser fornecidas no contexto do que o usuário consentiu.