Messages flash

Qu’est-ce qu’un message flash ?

Les réponses envoyées par l’API de MesVaccins.net peuvent contenir des messages à afficher dans le logiciel client. Ces messages s’adressent à l’utilisateur final et contiennent souvent des informations importantes : ils doivent donc être clairement affichés.

Exemple de message flash

Quand faut-il afficher les messages flash ?

Si l’objet de réponse (au format JSON) possède un champ flash_messages, ce dernier a pour valeur un tableau de messages flash. Le logiciel client doit alors parcourir ces messages et afficher chacun d’entre eux dans l’interface utilisateur.

Exemple d’objet de réponse contenant un message flash

{
  "flash_messages": [
    { "type": "notice",
      "content": "&lt;p\&gt;Vous avez signalé que toutes les vaccinations ont été saisies.&lt;/p&gt;&lt;p&gt;&lt;strong&gt;Votre patient sera donc prévenu automatiquement des prochains vaccins et rappels à faire.&lt;/strong&gt;&lt;/p&gt;" }
  ]
}

Quel est le format de chaque message flash ?

Comme dans l’exemple ci-dessus, chaque message flash possède deux champs.

Le champ type peut prendre les valeurs notice ou alert. Les messages de type notice sont simplement informatifs (notification de succès d’opération par exemple) et doivent donc être rendus dans un style graphique neutre. Les messages de type alert signalent un problème à l’utilisateur (échec d’opération par exemple) et doivent donc être rendus dans un style graphique plus agressif (couleur rouge).

Le champ content contient le message à afficher au format HTML.