docs: dokončit popis tříd
This commit is contained in:
parent
f9c4576cf1
commit
498e366e20
3 changed files with 64 additions and 4 deletions
|
@ -41,4 +41,4 @@ Metoda vrací `bool` nebo chybu. Pokud se nelze přihlásit pomocí jména nebo
|
||||||
|
|
||||||
## Dělejte co potřebujete
|
## Dělejte co potřebujete
|
||||||
|
|
||||||
Nyní byste měli být připravení na to, abyste posílali ostatní požadavky. Prohlédněte si [referenci](broken-reference), [podrobnou dokumentaci](https://pub.dev/documentation/canteenlib/latest/canteenlib/canteenlib-library.html) nebo [příklady](reference/priklady.md) pro pomoc s pokračováním.
|
Nyní byste měli být připravení na to, abyste posílali ostatní požadavky. Prohlédněte si [referenci](reference/prehled-trid.md), [podrobnou dokumentaci](https://pub.dev/documentation/canteenlib/latest/canteenlib/canteenlib-library.html) nebo [příklady](reference/priklady.md) pro pomoc s pokračováním.
|
||||||
|
|
|
@ -8,7 +8,6 @@ Reprezentuje jedno jídlo na burze, které není vaše, respektive uživatele, k
|
||||||
### Vlastnosti
|
### Vlastnosti
|
||||||
#### den
|
#### den
|
||||||
[`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html) - Den, který je jídlo vydáváno
|
[`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html) - Den, který je jídlo vydáváno
|
||||||
|
|
||||||
#### nazev
|
#### nazev
|
||||||
`String` - Název jídla
|
`String` - Název jídla
|
||||||
#### pocet
|
#### pocet
|
||||||
|
@ -40,7 +39,6 @@ Slouží pro uložení jídla uživatele do burzy
|
||||||
- [`Jidlo`](#jidlo) - Jídlo uživatele, které chce přesunout do burzy
|
- [`Jidlo`](#jidlo) - Jídlo uživatele, které chce přesunout do burzy
|
||||||
##### Vrací
|
##### Vrací
|
||||||
- [`Jidlo`](#jidlo) - Původní instance upravená o změněné parametry
|
- [`Jidlo`](#jidlo) - Původní instance upravená o změněné parametry
|
||||||
|
|
||||||
#### jidelnicekDen
|
#### jidelnicekDen
|
||||||
Slouží pro získání jídelníčku pro určitý den
|
Slouží pro získání jídelníčku pro určitý den
|
||||||
##### Parametry
|
##### Parametry
|
||||||
|
@ -66,4 +64,66 @@ Objedná jídlo z burzy uvedené v parametru
|
||||||
- [`Burza`](#burza) - Cizí jídlo z burzy, které chce uživatel objednat
|
- [`Burza`](#burza) - Cizí jídlo z burzy, které chce uživatel objednat
|
||||||
##### Vrací
|
##### Vrací
|
||||||
- `bool` - `true` v případě, že bylo jídlo úspěšně objednáno
|
- `bool` - `true` v případě, že bylo jídlo úspěšně objednáno
|
||||||
|
#### ziskatBurzu
|
||||||
|
Získá aktuální jídla v burze, která může uživatel objednat. (iCanteen ve výchozím stavu nezobrazuje jídla v burze pro dny, kdy má uživatel objednáno)
|
||||||
|
##### Vrací
|
||||||
|
- [`List`](https://api.dart.dev/stable/2.17.1/dart-core/List-class.html)[`Burza`](#burza) - Seznam jídel v burze
|
||||||
|
#### ziskejJidelnicek
|
||||||
|
Získá aktuální holý jídelníček (více dnů), jelikož bere z hlavní stránky, **není nutné přihlášení**
|
||||||
|
##### Vrací
|
||||||
|
- [`List`](https://api.dart.dev/stable/2.17.1/dart-core/List-class.html)[`Jidelnicek`](#jidelnicek) - Jídelníčky pro dny, které jsou zobrazené na hlavní stránce
|
||||||
|
#### ziskejUzivatele
|
||||||
|
Vrátí údaje o uživateli
|
||||||
|
##### Vrací
|
||||||
|
- [`Uzivatel`](#uzivatel) - Instance třídy obsahující všechny údaje, jsou-li vyplněné
|
||||||
|
|
||||||
|
## Jidelnicek
|
||||||
|
Třídá reprezentující jídelníček pro určitý den v týdnu
|
||||||
|
### Vlastnosti
|
||||||
|
####
|
||||||
|
#### den
|
||||||
|
[`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html) - Den, pro který jídelníček platí
|
||||||
|
#### jidla
|
||||||
|
[`List`](https://api.dart.dev/stable/2.17.1/dart-core/List-class.html)[`Jidlo`](#jidlo) - Seznam jídel v tomto jídelníčku
|
||||||
|
|
||||||
|
## Jidlo
|
||||||
|
Reprezentuje jedno určité jídlo v jídelníčku
|
||||||
|
### Vlastnosti
|
||||||
|
#### burzaUrl
|
||||||
|
`String?` - URL pro vložení jídla na burzu, je-li už objednáno
|
||||||
|
#### cena
|
||||||
|
`double` - Cena za jídlo
|
||||||
|
#### den
|
||||||
|
[`DateTime`](https://api.dart.dev/stable/2.17.1/dart-core/DateTime-class.html) - Den, který je jídlo vydáváno
|
||||||
|
#### lzeObjednat
|
||||||
|
`bool` - Udává, zda-li jde jídlo objednat
|
||||||
|
#### naBurze
|
||||||
|
`bool` - Udává, zda-li je jídlo aktuálně na burze
|
||||||
|
#### nazev
|
||||||
|
`String` - Název jídla
|
||||||
|
#### objednano
|
||||||
|
`bool` - Udává, zda-li si uživatel jídlo objednal nebo ne
|
||||||
|
#### orderUrl
|
||||||
|
`String?` - URL pro objednání/zrušení objednání jídla
|
||||||
|
#### varianta
|
||||||
|
`String` - Název varianty
|
||||||
|
|
||||||
|
## Uzivatel
|
||||||
|
Uchovává informace o přihlášeném uživateli
|
||||||
|
### Vlastnosti
|
||||||
|
#### jmeno
|
||||||
|
`String?` - Jméno, jak je uvedené v základních údajích o uživateli
|
||||||
|
#### kategorie
|
||||||
|
`String?` - Kategorie uživatele
|
||||||
|
#### Kredit
|
||||||
|
`double` - Aktuální stav kreditu
|
||||||
|
#### prijmeni
|
||||||
|
`String?` Příjmení, jak je uvedené v základních údajích o uživateli
|
||||||
|
#### specSymbol
|
||||||
|
`String?` - Specifický symbol
|
||||||
|
#### ucetProPlatby
|
||||||
|
`String?` - Účet jídelny pro zasílání plateb
|
||||||
|
#### uzivatelskeJmeno
|
||||||
|
`String?` - Uživatelské jméno
|
||||||
|
#### varSymbol
|
||||||
|
`String?` - Variabilní symbol
|
||||||
|
|
|
@ -1,2 +1,2 @@
|
||||||
# Příklady
|
# Příklady
|
||||||
|
TODO
|
||||||
|
|
Reference in a new issue