DOCS.md

ArgoAPI

Kind: global class

• ArgoAPI
  • new ArgoAPI()
  • .login(cod_min, username, password, loginwithtoken) ⇒ Promise.<string>
  • ._curl(request, auxiliaryHeader, auxiliaryQuery) ⇒ Promise.<{}>
  • .oggiScuola(datGiorno) ⇒ *
  • .isLogged() ⇒ boolean
  • .assenze() ⇒ *
  • .noteDisciplinari() ⇒ *
  • .votiGiornalieri() ⇒ *
  • .votiScrutinio() ⇒ *
  • .compiti() ⇒ *
  • .argomenti() ⇒ *
  • .promemoria() ⇒ *
  • .orario() ⇒ *
  • .docenti() ⇒ *

new ArgoAPI()

Istanza l'oggetto

argoAPI.login(cod_min, username, password, loginwithtoken) ⇒ Promise.<string>

Metodo per effettuare il login

Kind: instance method of ArgoAPI Returns: Promise.<string> - Promessa che viene risolta in caso di successo, i dati saranno alla proprietà 'scheda' della classe ArgoAPI

Param	Type	Default	Description
cod_min	string		Codice della scuola
username	string		Username del portale
password	string		Password o Token
loginwithtoken	number	0	Toggle per usare token o password, se inserito e uguale a 1 usa il token

argoAPI._curl(request, auxiliaryHeader, auxiliaryQuery) ⇒ Promise.<{}>

Metodo utilizzato per effettuarele richieste http al server rest d Argo

Kind: instance method of ArgoAPI Returns: Promise.<{}> - Promessa che restituisce il risultato della richiesta

Param	Type	Description
request	string	Tipo di richiesta
auxiliaryHeader	Object | Array	Header che si vuole passare
auxiliaryQuery	Object | Array	Query che si vuole passare

argoAPI.oggiScuola(datGiorno) ⇒ *

Metodo utilizzato per prendere la scheda "Accade oggi" in base alla data selezionata

Kind: instance method of ArgoAPI Returns: * - scheda del giorno sotto forma di oggetto

Param	Type	Description
datGiorno	String	Formato 'AAAA-MM-GG'

argoAPI.isLogged() ⇒ boolean

Kind: instance method of ArgoAPI Returns: boolean - Indica se si è loggati o meno

argoAPI.assenze() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente le assenze e i ritardi, se ci sono errori lancia un'eccezione

argoAPI.noteDisciplinari() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente le note disciplinari, se ci sono errori lancia un errore

argoAPI.votiGiornalieri() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente i voti giornalieri, se ci sono errori lancia un errore

argoAPI.votiScrutinio() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente i voti degli scrutini, se ci sono errori lancia un errore

argoAPI.compiti() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente i compiti assegnati, se ci sono errori lancia un errore

argoAPI.argomenti() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente gli argomenti, se ci sono errori lancia un errore

argoAPI.promemoria() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente i promemoria, se ci sono errori lancia un errore

argoAPI.orario() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente l'orario, se ci sono errori lancia un errore

argoAPI.docenti() ⇒ *

Kind: instance method of ArgoAPI Returns: * - Ritorna un oggetto contenente i docenti, se ci sono errori lancia un errore