Sockets

Config

Description

L’evenement config permet d’envoyer la configuration du miroir magique au client. Celui ci est envoyé lors de la connection du client au socket.

Paramètres

• _id=[string] : L’id de l’utilisateur, celui ci permet de retrouver et d’envoyer au client les données de configuration, si celles ci existent.

Valeurs de retour

Succès :
En cas de succès et si l’id est existant, le client reçoit un objet JSON contenant les données de configuration du miroir magique.
Les données sont les suivantes :

• _id=[string] : L’id de l’utilisateur

• timeZone=[object] : La configuration de la timeZone, comprenant:

  • code=[string] : Le code de la timeZone
  • offset=[string] : Le décalage horaire

• kioskIdleTime=[object] : heures d’activation et de désactivation du mode kiosk, comprenant:

  • start=[string] : L’heure de début
  • end=[string] : L’heure de fin

• isMilitaryTime=[boolean] : Le format de l’heure

• desktopIdleDelay=[int]: Le délai avant le passage en mode veille

• weather[object] : Objet gérant la météo, comprenant:

  • cityId=[string] : L’id de la ville
  • celcius=[boolean] : Le format de la température

• localization=[string]: La langue du miroir

• HTTP Code: 200

En cas de succès et si l’id n’existe pas, le client recoit le message suivant:

• "warning=[string]": "No data found with this id"
• HTTP Code: 204

Echec :
Si l’id est manquant, le client reçoit le message suivant :

• 'Error': '_id is required'

Update

Description

L’evenement update permet d’envoyer la mise à jour de la configuration du miroir magique au client. Celui ci est envoyé lors de la modification de la configuration du miroir magique. Cette evenement est déclenché sur tout les clients connectés au socket ayant un _id correspondant à celui de la configuration modifiée.

Valeurs envoyées

Lors de la mise a jour de la configuration, l’évenement update est déclenché et possède les valeurs suivantes :

• _id=[string] : L’id de l’utilisateur
• timeZone=[object] : La configuration de la timeZone, comprenant:
  • code=[string] : Le code de la timeZone
  • offset=[string] : Le décalage horaire
• kioskIdleTime=[object] : heures d’activation et de désactivation du mode kiosk, comprenant:
  • start=[string] : L’heure de début
  • end=[string] : L’heure de fin
• weather[object] : Objet gérant la météo, comprenant:
  • cityId=[string] : L’id de la ville
  • celcius=[boolean] : Le format de la température
• isMilitaryTime=[boolean] : Le format de l’heure
• desktopIdleDelay=[int]: Le délai avant le passage en mode veille
• localization=[string]: La langue du miroir