diff --git a/docs/DocumentationTechniqueMobile.md b/docs/DocumentationTechniqueMobile.md new file mode 100644 index 000000000..e4dca93f5 --- /dev/null +++ b/docs/DocumentationTechniqueMobile.md @@ -0,0 +1,405 @@ +# Classes + +## `/` + +
+
ChoixDept
+

Page de choix du département

+
+
Etudiant
+

Page d'information d'un étudiant'

+
+
GestionSemestre
+

Page de gestion du semestre

+
+
Login
+

Page de Login

+
+
Scolarite
+

Page de choix du semestre

+
+
ScoNavBar
+

Barre de navigation

+
+
SearchStudent
+

Module de recherche d'étudiant

+
+
+ +## `/GestionSemestre` + +
+
Absences
+

Page de gestion des absences

+
+
Accueil
+

Page d'accueil de la gestion du semestre

+
+
Bulletin
+

Page de présentation des bulletins étudiants

+
+
Etudiants
+

Page de présentation des étudiants inscrits au semestre

+
+
+ +## `/GestionSemestre/Absences` + +
+
JustAbs
+

Module de justification des absences

+
+
SaisieAbs
+

Module de saisie des absences

+
+
SupprAbs
+

Module de suppression des absences

+
+
+
+ +--- +# Functions + +
+
get(url) ⇒ Promise.<Response>
+

Lance une requête GET a l'URL donnée en paramètre et retourne une Promise.

+
+
getLogin(url, login, pass) ⇒ Promise.<Response>
+

Lance une requête GET a l'URL donnée en paramètre et retourne une Promise. +Dans ce cas particulier, on ajoute un header d'authentification.

+
+
getJson(url) ⇒ Promise.<{data: any}>
+

Lance une requête GET a l'URL donnée en paramètre et retourne les données JSON d'une Promise.

+
+
post(url, data) ⇒ Promise.<Response>
+

Lance une requête POST a l'URL donnée en paramètre et retourne une Promise.

+
+
+
+ +--- +## `/` + + + +## ChoixDept +Page de choix du département + +**Kind**: global class + + +### choixDept.getData() +Recupère la liste des départements depuis l'API + +**Kind**: instance method of [ChoixDept](#ChoixDept) + + +## Etudiant +Page d'information d'un étudiant' + +**Kind**: global class + + +### etudiant.getData() +Recupère les données de l'étudiant depuis l'API + +**Kind**: instance method of [Etudiant](#Etudiant) + + +## GestionSemestre +Page de gestion du semestre + +**Kind**: global class + + +### gestionSemestre.getData() +Recupère la liste des étudiants inscrits au semestre pour le Select depuis l'API + +**Kind**: instance method of [GestionSemestre](#GestionSemestre) + + +## Login +Page de Login + +**Kind**: global class + + +### login.checkCredentials(e) +Verifie la validité des identifiants depuis l'API + +**Kind**: instance method of [Login](#Login) + +| Param | Type | +| --- | --- | +| e | event | + + + +## Scolarite +Page de choix du semestre + +**Kind**: global class + + +### scolarite.getData() +Recupère la liste des semestres depuis l'API + +**Kind**: instance method of [Scolarite](#Scolarite) + + +## ScoNavBar +Barre de navigation + +**Kind**: global class + + +## SearchStudent +Module de recherche d'étudiant + +**Kind**: global class + +* [SearchStudent](#SearchStudent) + * [.searchStudent(search)](#SearchStudent+searchStudent) + * [.result()](#SearchStudent+result) ⇒ JSX.Element + + + +### searchStudent.searchStudent(search) +Lance une recherche de l'étudiant depuis l'API + +**Kind**: instance method of [SearchStudent](#SearchStudent) + +| Param | Type | Description | +| --- | --- | --- | +| search | String | Texte recherché | + + + +### searchStudent.result() ⇒ JSX.Element +Presentation du résultat + +**Kind**: instance method of [SearchStudent](#SearchStudent) +**Returns**: JSX.Element - - Resultat au format JSX +
+ +--- +## `/GestionSemestre` + + + +## Absences +Page de gestion des absences + +**Kind**: global class + +* [Absences](#Absences) + * [.openModal(key, data)](#Absences+openModal) + * [.getData()](#Absences+getData) + + + +### absences.openModal(key, data) +Gère l'ouverture des Modal + +**Kind**: instance method of [Absences](#Absences) + +| Param | Type | Description | +| --- | --- | --- | +| key | String | Correspond au type de modal [isOpen, isDelOpen, isJustOpen] | +| data | Object | Objet contenant les données à transmettre | + + + +### absences.getData() +Recupère les données d'absences depuis l'API + +**Kind**: instance method of [Absences](#Absences) + + +## Accueil +Page d'accueil de la gestion du semestre + +**Kind**: global class + + +### accueil.getData() +Recupère les données du semestre selectionné depuis l'API + +**Kind**: instance method of [Accueil](#Accueil) + + +## Bulletin +Page de présentation des bulletins étudiants + +**Kind**: global class + +* [Bulletin](#Bulletin) + * [.getData()](#Bulletin+getData) + * [.getPdf()](#Bulletin+getPdf) + + + +### bulletin.getData() +Recupère les données de bulletin depuis l'API + +**Kind**: instance method of [Bulletin](#Bulletin) + + +### bulletin.getPdf() +Recupère les données de bulletin en tant que "blob" pour un PDF depuis l'API + +**Kind**: instance method of [Bulletin](#Bulletin) + + +## Etudiants +Page de présentation des étudiants inscrits au semestre + +**Kind**: global class + + +### etudiants.getData() +Recupère la liste des étudiants inscrits au semestre depuis l'API + +**Kind**: instance method of [Etudiants](#Etudiants) +
+ +--- + +## `/GestionSemestre/Absences` + + + +## JustAbs +Module de justification des absences + +**Kind**: global class + +* [JustAbs](#JustAbs) + * [.onFormSubmit](#JustAbs+onFormSubmit) + * [.postData(data)](#JustAbs+postData) + + + +### justAbs.onFormSubmit +Gestion des données du formulaire + +**Kind**: instance property of [JustAbs](#JustAbs) + +| Param | Type | +| --- | --- | +| e | Event | + + + +### justAbs.postData(data) +Envoie une requête POST a l'API + +**Kind**: instance method of [JustAbs](#JustAbs) + +| Param | Type | Description | +| --- | --- | --- | +| data | String | Données à envoyer sous la forme param1=val1¶m2=val2... | + + + +## SaisieAbs +Module de saisie des absences + +**Kind**: global class + +* [SaisieAbs](#SaisieAbs) + * [.onFormSubmit](#SaisieAbs+onFormSubmit) + * [.postData(data)](#SaisieAbs+postData) + + + +### saisieAbs.onFormSubmit +Gestion des données du formulaire + +**Kind**: instance property of [SaisieAbs](#SaisieAbs) + +| Param | Type | +| --- | --- | +| e | Event | + + + +### saisieAbs.postData(data) +Envoie une requête POST a l'API + +**Kind**: instance method of [SaisieAbs](#SaisieAbs) + +| Param | Type | Description | +| --- | --- | --- | +| data | String | Données à envoyer sous la forme param1=val1¶m2=val2... | + + + +## SupprAbs +Module de suppression des absences + +**Kind**: global class + + +### supprAbs.postData(data) +Envoie une requête POST a l'API + +**Kind**: instance method of [SupprAbs](#SupprAbs) + +| Param | Type | Description | +| --- | --- | --- | +| data | String | Données à envoyer sous la forme param1=val1¶m2=val2... | +
+ +--- + +## Global + + + +## get(url) ⇒ Promise.<Response> +Lance une requête GET a l'URL donnée en paramètre et retourne une Promise. + +**Kind**: global function + +| Param | Type | Description | +| --- | --- | --- | +| url | String | URL de la requête | + + + +## getLogin(url, login, pass) ⇒ Promise.<Response> +Lance une requête GET a l'URL donnée en paramètre et retourne une Promise. Dans ce cas particulier, on ajoute un header d'authentification. + +**Kind**: global function + +| Param | Type | Description | +| --- | --- | --- | +| url | String | URL de la requête | +| login | String | Identifiant | +| pass | String | Mot de passe | + + + +## getJson(url) ⇒ Promise.<{data: any}> +Lance une requête GET a l'URL donnée en paramètre et retourne les données JSON d'une Promise. + +**Kind**: global function + +| Param | Type | Description | +| --- | --- | --- | +| url | String | URL de la requête | + + + +## post(url, data) ⇒ Promise.<Response> +Lance une requête POST a l'URL donnée en paramètre et retourne une Promise. + +**Kind**: global function + +| Param | Type | Description | +| --- | --- | --- | +| url | String | URL de la requête | +| data | String | Données de la requête au format "param1=val1¶m2=val2..." | +