Quick Start
Jak začít s používáním API
Využívání balíku je na vlastní nebezpečí, neručíme za škody způsobené používáním!
Knihovna je hostována na pub.dev, instalace se provede jednoduše pomocí
dart pub add canteenlib
, pokud používáte Flutter pak flutter pub add canteenlib
Základem je vytvoření instance třídy
Canteen
, která obsahuje všechny metody pro komunikaci s iCanteen. Jediný parametr této třídy je URL k vašemu kýženému iCanteen.import 'package:canteenlib/canteenlib.dart';
// ...
Canteen c = Canteen("https://kantyna.neco.cz");
// ...
Přihlášení za váš účet provedete pomocí metody
login
, parametry jsou uživatelské jméno a heslo.Knihovna používá hlavně asynchronní funkce, které vrací Future, doporučujeme používat uvnitř jiné asynchronní funkce s
await
.// ...
Canteen c = Canteen("https://kantyna.neco.cz");
var l = await c.login("jmeno","heslo")
Metoda vrací
bool
nebo chybu. Pokud se nelze přihlásit pomocí jména nebo hesla, vrací metoda false
, v případě jiné chyby Future.error
a při úspěšném přihlášení true
.Nyní byste měli být připravení na to, abyste posílali ostatní požadavky. Prohlédněte si referenci, podrobnou dokumentaci nebo příklady pro pomoc s pokračováním.
Last modified 7mo ago