Nosso SDK emite eventos quando um usuário interage com nossos banners ou nossa API.

Para executar ações personalizadas com base no ciclo de vida do nosso banner no seu site, você pode ouvir os diferentes eventos que ele emite.

Eventos emitidos

ready

Emitido quando o SDK Axeptio é carregado e inicializado.

consent:saved

Este evento é emitido quando um consentimento foi enviado com sucesso e processado pela API do Axeptio. O payload contém as preferências do usuário e os metadados descrevendo o consentimento.

cookies:complete

Evento emitido pelo serviço Cookies quando o Axeptio tem conhecimento dos fornecedores que foram aceitos ou rejeitados. Como este evento é usado para disparar a execução dos fornecedores selecionados e scripts, cookies:complete é emitido mesmo se o banner de cookies não aparecer. Se o Axeptio encontrar preferências nos cookies do navegador, o SDK emite o evento e bloqueia a exibição do banner.

axeptio.on("cookies:complete", function (choices) {  if (choices.google_analytics) {    startGoogleAnaytics();  }});

cookies:step:change

Quando o banner de cookies está aberto, este evento é emitido quando um usuário muda de etapa. O payload é um objeto que contém uma propriedade chamada index representando o índice (em forma de número inteiro) da etapa (step) no array de etapas (steps). Ele também contém a definição da etapa (identificador, título, descrição, lista de fornecedores, etc.).

cookies:step.startTimeout

Emitido quando uma etapa do tipo "Tela de informações" inicia sua contagem regressiva antes de passar para a próxima etapa.

cookies:step.stopTimeout

Emitido quando uma etapa do tipo "Tela de informações" atinge o fim de sua contagem regressiva ou é interrompida pelo usuário.

token:update

O token do usuário pode ser atualizado durante a sessão, por exemplo, quando é baseado em um campo de entrada ou deduzido de uma chamada AJAX. Este evento é emitido quando o token contido no SDK é atualizado.

overlayOpenWidget

Permite disparar imperativamente o aparecimento do botão Axeptio.

overlayOpenCookies

Permite disparar imperativamente o aparecimento do banner de cookies Axeptio.

showProcessingDetails

Emitido quando a sobreposição é aberta com os detalhes de um processamento de dados. Pode ser usado imperativamente para exibir a sobreposição do Axeptio.

close

Acionado quando a sobreposição é fechada. Pode ser usado imperativamente para disparar seu aparecimento.

Sob o capô

Nosso SDK implementa uma classe personalizada EventEmitter que expõe três métodos:

EventEmitter.on

on(event:String, handler:Function, options = {replay: true, once: false})

O parâmetro event aceita curingas * para ouvir vários eventos ao mesmo tempo. Por exemplo, você pode passar cookies:* para receber todos os eventos relacionados ao banner de cookies.
O parâmetro handler é uma função que é chamada quando o emissor do evento emite um evento correspondente ao padrão do parâmetro event. O handler recebe dois argumentos:
1. O payload relacionado ao evento
2. O nome exato do evento emitido
O parâmetro options, opcional, é um objeto composto pelos seguintes sinalizadores:
- Se replay tem o valor true, os eventos passados que foram emitidos antes do handler ser definido farão com que o handler seja chamado imediatamente. Se tiver o valor false, apenas os eventos futuros dispararão uma chamada do handler.
- Se once tem o valor true, o handler será chamado apenas uma vez. Depois de ser chamado, nenhum outro evento satisfazendo o padrão o acionará novamente.

EventEmitter.off

off(event:String, handler:Function = undefined)

O método off desinscreve o handler especificado para o event especificado, se for definido como segundo parâmetro da função. Se handler não for definido, cada handler ouvindo o padrão exato event será removido do array de handlers.

EventEmitter.trigger

trigger(event:String, payload:Object = undefined)

Este método é usado para disparar um evento e transmitir dados de qualquer tipo através do parâmetro payload.

Ouvir eventos do SDK