ScoDocMobile/Documentation.md

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

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

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

Login

Page de Login

Kind: global class

login.checkCredentials(e)

Verifie la validité des identifiants depuis l'API

Kind: instance method of 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

ScoNavBar

Barre de navigation

Kind: global class

SearchStudent

Module de recherche d'étudiant

Kind: global class

• SearchStudent
  • .searchStudent(search)
  • .result() ⇒ JSX.Element

searchStudent.searchStudent(search)

Lance une recherche de l'étudiant depuis l'API

Kind: instance method of SearchStudent

Param	Type	Description
search	String	Texte recherché

searchStudent.result() ⇒ JSX.Element

Presentation du résultat

Kind: instance method of SearchStudent
Returns: JSX.Element - - Resultat au format JSX

---

/GestionSemestre

Absences

Page de gestion des absences

Kind: global class

• Absences
  • .openModal(key, data)
  • .getData()

absences.openModal(key, data)

Gère l'ouverture des Modal

Kind: instance method of 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

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

Bulletin

Page de présentation des bulletins étudiants

Kind: global class

• Bulletin
  • .getData()
  • .getPdf()

bulletin.getData()

Recupère les données de bulletin depuis l'API

Kind: instance method of 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

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

---

/GestionSemestre/Absences

JustAbs

Module de justification des absences

Kind: global class

• JustAbs
  • .onFormSubmit
  • .postData(data)

justAbs.onFormSubmit

Gestion des données du formulaire

Kind: instance property of JustAbs

Param	Type
e	Event

justAbs.postData(data)

Envoie une requête POST a l'API

Kind: instance method of JustAbs

Param	Type	Description
data	String	Données à envoyer sous la forme param1=val1&param2=val2...

SaisieAbs

Module de saisie des absences

Kind: global class

• SaisieAbs
  • .onFormSubmit
  • .postData(data)

saisieAbs.onFormSubmit

Gestion des données du formulaire

Kind: instance property of SaisieAbs

Param	Type
e	Event

saisieAbs.postData(data)

Envoie une requête POST a l'API

Kind: instance method of SaisieAbs

Param	Type	Description
data	String	Données à envoyer sous la forme param1=val1&param2=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

Param	Type	Description
data	String	Données à envoyer sous la forme param1=val1&param2=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&param2=val2..."