Les services¶

yes

Authentification¶

Le service d’authentification permet de gérer les identitées, les droits et les sessions des utilisateurs. Il utilise le service Authentification de firebase (voir Firebase, base de donnée en temps réel)

createUser(email, password, name)¶

Crée un compte utilisateur avec les identifiants donnés.

Parameters:	email (string) – Addresse mail de l’utilisateur password (string) – mot de passe de l’utilisateur name (object) – Objet contenant le nom et le prenom de l’utilisateur
Return type:	`True` ou `False`

login(email, password)¶

Permet à l’utilisateur de se connecter avec le couple email:mot de passe donné.

Parameters:	email (string) – Addresse mail de l’utilisateur password (string) – mot de passe de l’utilisateur
Return type:	`True` ou `False`

logout()¶

Déconnecte l’utilisateur actuel.

Return type:	`True` ou `False`

User¶

Le service User met à disposition permettant de configurer le profile et le compte des utilisateurs.

getCurrentUserProfile(id)¶

Récupère les informations liées à l’utilisateur actuel.

Return type:	Objet contenant les données de l’utilisateur.

updateCurrentUserProfile(data)¶

Met à jour les informations de l’utilisateur actuel.

Parameters:	data (object) – Objet contenant les données a mettre à jour.
Return type:	Objet contenant les données de l’utilisateur.

Family¶

Le service Family offre une API permettant la gestion des cercles de confiance.

getCurrentUserFamily()¶

Permet de récupérer les familles liées à l’utilisateur actuellement connecté.

Return type:	Identifiant de la famille.

getFamily(id)¶

Récupère les informations liées à une famille à partir de son identifiant.

Parameters:	id (string) – identifiant de la famille
Return type:	Objet contenant les données de la famille.

createFamily()¶

Permet à l’utilisateur actuel de créer une famille. Il sera automatiquement ajouté à cette dernière.

Return type:	`True` ou `False`

invitToFamily(email, role)¶

Ajoute un membre dans une famille.

Parameters:	email (string) – Email du membre à ajouter. role (string) – Role du membre, parmis: `Aidant`, `helpers` ou `members`
Return type:	`True` ou `False`

addChildrenToFamily(family, name, address)¶

Ajoute un enfant dans une famille.

Parameters:	family (string) – Identifiant de la famille à laquelle l’enfant appartiens. name (object) – Objet contenant le nom et le prenom de l’enfant address (string) – Addresse de domicile de l’enfant.
Return type:	`True` ou `False`

Alert¶

Le service d’alerte offre une API permettant de manipuler le système d’alertes de l’application Sokkin. Voir Les alertes pour plus d’informations sur les alertes.

getMyAlerts(status=None)¶

Récupère la liste des alertes de l’utilisateur en cours.

Parameters:	status (string) – Paramètre facultatif permettant de filtrer la liste en fonction de leur status. Le status d’une alerte est une chaîne de charactères parmis : `Pending`, `Started` ou `Finished`
Return type:	Une liste contenant les identifiants des alertes.

setAlert(status)¶

Permet de changer le status d’une alerte.

Parameters:	status (string) – Le status d’une alerte est une chaîne de charactères parmis : `Pending`, `Started` ou `Finished`
Return type:	`True` ou `False`

Feedbacks¶

??