Show Menu
TÓPICOS×

Execução de comandos

Depois que o código base for implementado em sua página da Web, você poderá começar a executar comandos com o SDK. Não é necessário aguardar o carregamento do arquivo externo \( alloy.js \) do servidor antes de executar comandos. Se o SDK não tiver concluído o carregamento, os comandos serão enfileirados e processados pelo SDK assim que possível.
Os comandos são executados usando a seguinte sintaxe.
alloy("commandName", options);

O commandName informa ao SDK o que fazer, embora options sejam os parâmetros e dados que você gostaria de passar para 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

As promessas são fundamentais para como o SDK se comunica com o código na sua página da Web. Uma promessa é uma estrutura de programação comum e não é específica para esse SDK ou mesmo para JavaScript. Uma promessa atua como um proxy para um valor que não é conhecido quando a promessa é criada. Quando o valor é conhecido, a promessa é "resolvida" com o valor. As funções de 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 resolução da promessa. Para saber mais sobre as promessas, leia este tutorial ou qualquer outro recurso na web.

Lidar com 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 é bem-sucedido, você poderá remover a then chamada.
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, poderá remover a catch chamada.
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 um 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 seguinte comando.
alloy("getLibraryInfo").then(function(result) {
  console.log(results.libraryInfo.version);
});

Consentimento

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