Listeners de eventos

O SDK fornece vários ouvintes de eventos para lidar com diferentes eventos durante o processo de captura do documento. Esses ouvintes permitem que você execute lógica personalizada quando eventos específicos ocorrerem.

addEventListener

O addEventListener método é usado para ouvir eventos do tipo.

documentDetector.addEventListener(type, listener, options);

Parâmetros

• tipo (EventType): O tipo de evento a ser ouvido (consulte EventType para detalhes).
• listener (função): A função a ser executada quando o evento for acionado.
• options (objeto, opcional): Opções adicionais para o ouvinte de eventos

removeEventListener

O removeEventListener método é usado para remover um ouvinte de eventos do tipo.

documentDetector.removeEventListener(type, callback, options);

Parâmetros

• tipo (EventType): O tipo de evento a ser ouvido (consulte EventType para detalhes).
• callback (função): A função a ser removida.
• options (objeto, opcional): Opções adicionais para o ouvinte de eventos

EventType

Tipo	Descrição
"front_capture_started"	Disparado quando a captura da frente do documento foi iniciada.
"back_capture_started"	Disparado quando a captura do verso do documento foi iniciada.
"capture_invalid"	Disparado quando ocorre um erro em alguma validação realizada pelo SDK.
"capture_failed"	Disparado quando ocorre um erro que não é tratado pelo SDK.
"capture_ready"	Disparado quando a tela de captura do SDK (pré-visualização da câmera ou interface de upload) é renderizada e está pronta para a interação do usuário. Detalhe do evento: mode, expectedDocumentType, expectedDocumentSide.
"upload_button_clicked"	Disparado quando o usuário clica no botão de upload no modo de upload.
"capture_result"	Disparado após um documento ser capturado e validado com sucesso. Detalhe do evento: mode, isValid, expectedDocumentType, expectedDocumentSide.

Exemplo

// Ouça o evento quando a captura da frente do documento começar
documentDetector.addEventListener('front_capture_started', () => {
    console.debug('Evento de captura da frente do documento acionado');
});

// Ouça o evento quando a captura do verso do documento começar
documentDetector.addEventListener('back_capture_started', () => {
    console.debug('Evento de captura do verso do documento acionado');
});

// Ouça o evento quando a interface do SDK estiver pronta para a interação do usuário
documentDetector.addEventListener('capture_ready', (event) => {
    console.debug('O SDK está pronto para a captura', {
        mode: event.detail?.mode,
        expectedDocumentType: event.detail?.expectedDocumentType,
        expectedDocumentSide: event.detail?.expectedDocumentSide,
    });
});

// Ouça o evento quando o usuário clicar no botão de upload
documentDetector.addEventListener('upload_button_clicked', () => {
    console.debug('Botão de upload clicado');
});

// Ouça o evento quando um resultado de captura estiver disponível
documentDetector.addEventListener('capture_result', (event) => {
    console.debug('Resultado da captura', {
        mode: event.detail?.mode,
        isValid: event.detail?.isValid,
        expectedDocumentType: event.detail?.expectedDocumentType,
        expectedDocumentSide: event.detail?.expectedDocumentSide,
    });
});