Aller au contenu principal

Rappels

L'iframe communique avec l'application hôte en envoyant des messages de rappel. Chaque rappel a une forme stable et est livré via un transport qui dépend de l'endroit où l'iframe est intégré.

Transports par plateforme​

  • Web : transport window.postMessage ; écouteur window.addEventListener("message", ...).
  • iOS : transport gestionnaire de message webkit (bridge) ; écouteur WKScriptMessageHandler.
  • Android : transport objet JS injecté (legitHealthJsObject) ; écouteur WebViewCompat.postWebMessage.

Pour le code d'intégration sur chaque plateforme, voir la section Plateformes.

Catalogue des rappels​

  • analysis_completed : se déclenche quand l'image a été traitée et le rapport est prêt. La charge utile inclut l'id du rapport.
  • invalid_company_key : se déclenche quand l'iframe ne peut pas charger car la clé company est invalide. La charge utile inclut l'id (la clé offensante).
  • image_rejected : se déclenche quand une image téléchargée échoue le test de qualité. La charge utile est un tableau payload[] avec les raisons du rejet.

Les trois messages partagent la même enveloppe:

{
  message: "<message_name>",
  id: "<resource or key id>",
  payload: <message-specific data>  // when applicable
}

Les pages qui suivent documentent chaque rappel en détail ainsi que le code spécifique à chaque plateforme dont vous avez besoin pour le recevoir.

Étapes suivantes​

  • Voir le code spécifique à la plateforme ? Allez à la section Plateformes.
  • Prêt à récupérer le rapport ? Voir la page Sortie → Point de terminaison API.
  • Vouloir traiter les résultats ? Voir la section Sortie.