docs: aktualizovat přehled tříd

This commit is contained in:
Matyáš Caras 2022-06-02 16:19:12 +02:00
parent 081dcb887b
commit f9c4576cf1

View file

@ -2,3 +2,68 @@
Zde jsou zdokumentované všechny třídy, které lze uvnitř knihovny najít.
## Burza
Reprezentuje jedno jídlo na burze, které není vaše, respektive uživatele, který je přihlášený.
### Vlastnosti
#### den
[`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html) - Den, který je jídlo vydáváno
#### nazev
`String` - Název jídla
#### pocet
`int` - Počet kusů tohoto jídla v burze
#### url
`String?` - URL pro objednání jídla
#### varianta
`String?` - Druh varianty
## Canteen
Reprezentuje kantýnu / instanci iCanteen.
Slouží pro uchovávání metod, pomocí kterých se komunikuje s instancí.
### Vlastnosti
#### cookies
[`Map`](https://api.dart.dev/stable/2.17.1/dart-core/Map-class.html)`<String, String>` - Obsahuje všechny sušenky, které jsou vyžadovany pro úspěšnou komunikaci, např. pro identifikaci uživatele
#### prihlasen
`bool` - Slouží k informování, zda-li je uživatel přihlášen
#### url
`String` - URL adresa instance kantýny
### Metody
{% hint style="danger" %}
Všechny metody vrací Future, pro získání hodnoty je nutné použít `.then` nebo `await`.
{% endhint %}
#### doBurzy
Slouží pro uložení jídla uživatele do burzy
##### Parametry
- [`Jidlo`](#jidlo) - Jídlo uživatele, které chce přesunout do burzy
##### Vrací
- [`Jidlo`](#jidlo) - Původní instance upravená o změněné parametry
#### jidelnicekDen
Slouží pro získání jídelníčku pro určitý den
##### Parametry
- `den` - [`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html)`?` *(volitelný)* - určuje pro který den chceme získat jídelníček; není-li zadán, je použito dnešní datum
##### Vrací
- [`Jidelnicek`](#jidelnicek) - Jídelníček pro daný den
#### login
Slouží pro autorizaci a přihlášení uživatele
##### Parametry
- `String` - uživatelské jméno
- `String` - heslo
##### Vrací
- `bool` - `true` v případě přihlášení, jinak `false`
#### objednat
Objedná jídlo zadané v parametru
##### Parametry
- [`Jidlo`](#jidlo) - Jídlo, které chce uživatel objednat
##### Vrací
- [`Jidlo`](#jidlo) - Instance upravená o změněné parametry
#### objednatZBurzy
Objedná jídlo z burzy uvedené v parametru
##### Parametry
- [`Burza`](#burza) - Cizí jídlo z burzy, které chce uživatel objednat
##### Vrací
- `bool` - `true` v případě, že bylo jídlo úspěšně objednáno