From aa71619106a52301f54b822d9690c44cb44ddf82 Mon Sep 17 00:00:00 2001
From: HAUTBOIS Aurelie <aurelie.hautbois@ext.soprasteria.com>
Date: Thu, 21 Jan 2021 11:52:23 +0100
Subject: [PATCH] add user data to initialization.md
---
docs/ecolyo/functionalities/initialization.md | 31 +++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/docs/ecolyo/functionalities/initialization.md b/docs/ecolyo/functionalities/initialization.md
index 8d55502..c3bfc13 100644
--- a/docs/ecolyo/functionalities/initialization.md
+++ b/docs/ecolyo/functionalities/initialization.md
@@ -53,3 +53,34 @@ You can see more on [cozy documentation](https://docs.cozy.io/en/cozy-doctypes/d
}
}
```
+
+### UserData creation
+
+We create a userData and store it in the couchDB under the doctype userData name '**com.grandlyon.ecolyo.userDataName'.** During this process, the objects related to the dataEntity will be be converted to an user version which contains informations about the user(example: user progress, the fluids connected and so on).
+
+To illustrate this, let's show an example of the conversion of quizEntity to userQuiz :
+
+```jsx
+DuelEntity {
+ id: string
+ title: string
+ description: string
+ duration: Duration
+}
+```
+
+Becomes :
+
+```jsx
+UserQuiz {
+ id: string
+ title: string
+ description: string
+ duration: Duration
+ threshold: number
+ state: UserDuelState
+ startDate: string | null
+ fluidTypes: FluidType[]
+ userConsumption: number
+}
+```
--
GitLab