Os eventos Canopus

O plugin canopus possui em seu core um gerenciador de eventos que dispara gatilhos que podem ser escutados por scripts de terceiros, com a finalidade de incrementar eventos, trackear informações e gerenciar ações.

Para escutar um evento, você deve registrar um escutador seguindo a seguinte sintaxe:

CanopusEventCenter.addListener('nome-do-evento', function(dados) {
    // Alguma ação a partir do evento com os dados recebidos
});

E os eventos disponíveis são:

• Checkout.Adding disparado antes da requisição que envia os dados para a API de adicionar itens ao carrinho. Nenhum dado adicional;
• Checkout.Updated disparado após a requisição que envia os dados para a API de adicionar itens ao carrinho caso a resposta da mesma indique uma edição dos dados. Dados adicionais:
  • Id do item adicionado;
  • Ação realizada no carrinho;
  • Tipo do item adicionado, pode ser item ou plan;
  • Quantidade adicionada;
• Checkout.Added disparado após a requisição que envia os dados para a API de adicionar itens ao carrinho caso a resposta da mesma indique uma adição dos dados. Dados adicionais:
  • Id do item adicionado;
  • Ação realizada no carrinho;
  • Tipo do item adicionado, pode ser item ou plan;
  • Quantidade adicionada;
• Checkout.AddedAvailableQuantity disparado após a requisição que envia os dados para a API de adicionar itens ao carrinho caso a resposta da mesma indique uma adição parcial dos dados, numa quantidade diferente da informada por causa da trava de estoque. Dados adicionais:
  • Id do item adicionado;
  • Ação realizada no carrinho;
  • Tipo do item adicionado, pode ser item ou plan;
  • Quantidade adicionada;
• Identification.Login.LoggingIn disparado antes da requisição que envia os dados para a API de login. Dados adicionais:
  • E-mail informado pelo usuário;
• Identification.Login.LoggedIn disparado após o retorno com sucesso da API de login. Nenhum dado adicional;
• Identification.Login.Failed disparado após o retorno com erro da API de login. Dados adicionais:
  • Mensagem de erro retornada pela API;
• Identification.Identification.VerifyingEmail disparado antes do envio da API de verificação de existência de e-mail, durante o processo de identificação. Dados adicionais:
  • E-mail informado pelo usuário;
• Identification.Identification.EmailExists disparado após o retorno da API de verificação de existência de e-mail em caso positivo (e-mail existente na base). Dados adicionais:
  • E-mail informado pelo usuário;
• Identification.Identification.Failed disparado após o retorno da API de verificação de existência de e-mail em caso negativo (e-mail não existente na base). Dados adicionais:
  • E-mail informado pelo usuário;
• IdentificationoModal.Opening disparado antes da abertura do modal de identificação padrão, montado pelo canopus. Nenhum dado adicional.
• Showcase.InfiniteScroll.Loading disparado antes do carregamento da vitrine de carregamento infinito. Dados adicionais:
  • URL;
  • Offset;
  • Limite;
  • Parâmetros de ordenação;
  • Filtros;
• Showcase.InfiniteScroll.Loaded disparado após o carregamento da vitrine de carregamento infinito. Nenhum dado adicional;
• Showcase.InfiniteScroll.EmptyResponse disparado após o carregamento da vitrine de carregamento infinito, caso nenhum produto seja carregado. Nenhum dado adicional;
• ItemCommenter.Commenting disparado antes do envio de dados à API de comentário de item. Dados adicionais:
  • ID do item;
  • Avaliação;
  • Nota/estrelas;
• ItemCommenter.Commented disparado após o retorno com sucesso da API de comentário de item. Dados adicionais:
  • ID do item;
  • Avaliação;
  • Nota/estrelas;
• ItemCommenter.Failed disparado após o retorno com erro da API de comentário de item. Dados adicionais:
  • ID do item;
  • Avaliação;
  • Nota/estrelas;
• ServerDataLoader.Loading disparado antes do envio de dados à API que carrega dados da sessão do usuário. Nenhum dado adicional;
• ServerDataLoader.Loaded disparado após o retorno com sucesso da API que carrega dados da sessão do usuário. Dados adicionais podem variar dependendo do escopo solicitado. Os escopos disponíveis são:
  • Escopo cart retorna os dados do carrinho do usuário;
  • Escopo client retorna os dados do cliente identificado ou null caso nenhum cliente tenha sido identificado.
• Identification.Logout.LoggingOff disparado antes do envio da requisição de logout. Nenhum dado adicional;
• Identification.Logout.LoggedOut disparado após o retorno com sucesso da requisição de logout. Nenhum dado adicional;
• Identification.Logout.Failed disparado após o retorno com erro da requisição de logout. Nenhum dado adicional;
• Checkout.Preview.Building disparado antes da montagem do modal de prévia do carrinho na tela. Nenhum dado adicional;
• Checkout.Preview.Built disparado após a montagem do modal de prévia do carrinho na tela. Nenhum dado adicional;
• Checkout.Preview.Closed disparado após o fechamento do modal de prévia do carrinho. Nenhum dado adicional;
• Identification.Register.Registering disparado antes do envio dos dados do usuário à API de cadastro. Dados adicionais:
  • Nome;
  • Sobrenome;
  • Telefone;
  • CPF;
  • E-mail;
  • Senha;
  • Confirmação de senha;
• Identification.Register.Registered disparado após o retorno com sucesso da API de cadastro. Dados adicionais:
  • Nome;
  • Sobrenome;
  • Telefone;
  • CPF;
  • E-mail;
  • Senha;
  • Confirmação de senha;
• Identification.Register.RegisteredAfterLogin disparado após o login automático feito após o cadastro. Dados adicionais:
  • Nome;
  • Sobrenome;
  • Telefone;
  • CPF;
  • E-mail;
  • Senha;
  • Confirmação de senha;
• Identification.Register.Failed disparado após o retorno com erro da API de cadastro. Dados adicionais:
  • Erros de validação retornados pela API;
• Identification.ClientLoggedIn disparado caso seja identificado algum cliente nos dados de cabeçalho. Dados adicionais:
  • document1
  • document2
  • email
  • full_name
  • id
  • legal_personality
  • name1
  • name2
  • tags
  • telephone
• Identification.ClientNotLoggedIn disparado caso o cliente não seja identificado nos dados de cabeçalho.
• ItemAvailabilityAlert.Submitting disparado antes do envio dos dados do cliente à API de aviso de disponibilidade de item. Dados adicionais:
  • E-mail;
  • ID do item;
• ItemAvailabilityAlert.Stored disparado após o retorno com sucesso da API de aviso de disponibilidade de item. Dados adicionais:
  • E-mail;
  • ID do item;
• ItemAvailabilityAlert.Failed disparado após o retorno com erro da API de aviso de disponibilidade de item. Dados adicionais:
  • E-mail;
  • ID do item;
• NewsletterEmail.Submitting disparado antes do envio dos dados do cliente para a base de newsletter da plataforma. Nenhum dado adicional;
• NewsletterEmail.Stored disparado após o retorno com sucesso do envio dos dados do cliente para a base de newsletter da plataforma. Dados adicionais:
  • E-mail;
  • Descrição;
• NewsletterEmail.Failed disparado após o retorno com erro do envio dos dados do cliente para a base de newsletter da plataforma. Dados adicionais:
  • E-mail;
  • Descrição;
• CostumerMessage.Triggering disparado antes do envio da mensagem do cliente na página de contato. Nenhum dado adicional;
• CostumerMessage.Triggered disparado após o retorno com sucesso da API de envio de mensagem do cliente na página de contato. Dados adicionais:
  • Assunto;
  • Nome;
  • Telefone;
  • E-mail;
  • Mensagem;
• CostumerMessage.Failed disparado após o retorno com erro da API de envio de mensagem do cliente na página de contato. Dados adicionais:
  • Assunto;
  • Nome;
  • Telefone;
  • E-mail;
  • Mensagem;

Novos eventos personalizados podem ser disparados por scripts de terceiros usando a central do canopus. Para isso, deve-se usar a seguinte sintaxe:

CanopusEventCenter.emitEvent('nome-do-evento', [dados, adicionais, como, array]);