Utilisation des notificateurs d’événements JavaScript

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

window.addEventListener('message', receiveMessage, false);

Pour plus d’informations sur l’autorisation de la communication inter-origines entre votre fenêtre parent et un iFrame, cliquez ici.

Réception de messages

Ensuite, définissez la fonction receiveMessage comme suit :

function receiveMessage(event) {
      var origin = event.origin || event.originalEvent.origin;
      var data = event.data;
      console.log(data, origin);
 
      switch (data) {
            case 'ESL:MESSAGE:REGISTER':
                  event.source.postMessage('ESL:MESSAGE:ACTIVATE_EVENTS', origin);
                  break;
            default:
                  event.source.postMessage(data, origin)
                  break;
      }
}

Si vous ne configurez pas votre système pour écouter ESL :MESSAGE :REGISTER puis renvoyer ESL :MESSAGE :ACTIVATE_EVENTS, vous ne pourrez plus recevoir d’événements. Vous devez inclure les éléments suivants dans votre fonction receiveMessage.

  case 'ESL:MESSAGE:REGISTER':
				event.source.postMessage('ESL:MESSAGE:ACTIVATE_EVENTS', origin);
				break;
				default:
				event.source.postMessage(data, origin)
			break;

Il s’agit du code minimal nécessaire à la configuration d’un notificateur d’événements, où le premier cas de commutation indique explicitement à OneSpan Sign que vous souhaitez vous inscrire à l’écoute d’événements.

Résultats

Une utilisation courante d’un notificateur d’événement peut consister à rediriger un signataire vers une autre page une fois qu’il a terminé de signer. Voici un exemple de la façon dont cela serait fait :

case 'ESL:MESSAGE:SUCCESS:SIGNER_COMPLETE ':
	event.source.postMessage(data, origin);
	window.location.href = "https://www.example.com"; //redirect page
	break;

Interruption de l’activité OneSpan Sign

À l’aide d’un notificateur d’événements, certains événements peuvent être temporairement arrêtés. Voici un exemple de code qui vous montre comment procéder :

switch (data) {
   ...
   case 'ESL:MESSAGE:STARTED:DOCUMENT_NAVIGATION':
     // Do some customized tasks, then notify OneSpan Sign of the same event.
     setTimeout(function(){
       event.source.postMessage(data, origin);
     }, 5000);
     break;
   ...
}

Pour les événements qui peuvent être interrompus, OneSpan Sign ne reprendra pas son activité normale tant que votre conteneur parent n’aura pas renvoyé le même message défini par la ligne event.source.postMessage(data, origin).

Pour plus d’informations sur les événements qui peuvent être interrompus, reportez-vous à la Notification Event Types.

Types d’événements de notification

Le tableau suivant décrit les types d’événements de notification que votre notificateur d’événements peut écouter.

Voici l’ordre attendu des événements pour une transaction typique avec un signataire externe, un document de consentement par défaut et un document à signer :

ESL :MESSAGE :ENREGISTRER

ESL :MESSAGE :SUCCÈS :DOCUMENT_NAVIGATION

ESL :MESSAGE :SUCCÈS :DOCUMENT_VIEW

ESL :MESSAGE :STARTED :ACCEPTER

ESL :MESSAGE :SUCCÈS :ACCEPTER

ESL :MESSAGE :DEMARRÉ :DOCUMENT_NAVIGATION

ESL :MESSAGE :SUCCÈS :DOCUMENT_NAVIGATION

ESL :MESSAGE :SUCCÈS :DOCUMENT_VIEW

ESL :MESSAGE :DEMARRÉ :DOCUMENT_CONFIRM

ESL :MESSAGE :SUCCÈS :DOCUMENT_CONFIRM

ESL :MESSAGE :DEMARRÉ :SIGNER_COMPLETE

ESL :MESSAGE :SUCCÈS :SIGNER_COMPLETE

ESL :MESSAGE :DEMARRÉ :SIGNER_COMPLETE_REVIEWED

ESL :MESSAGE :SUCCÈS :SIGNER_COMPLETE_REVIEWED