GitBook: [#2] No subject

This commit is contained in:
hernik 2022-06-02 13:24:53 +00:00 committed by gitbook-bot
parent 16e3132d99
commit 081dcb887b
No known key found for this signature in database
GPG key ID: 07D2180C7B12D0FF
5 changed files with 78 additions and 0 deletions

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# Vítejte!
Toto je oficiální, člověkem čitelná, dokumentace pro Dart knihovnu [canteenlib](https://pub.dev/packages/canteenlib)
## Jdeme na to?
Quick start vám ukáže, jak rychle začít používat tuto knihovnu
{% content-ref url="quick-start.md" %}
[quick-start.md](quick-start.md)
{% endcontent-ref %}
## Má to hlubší význam?
Většina tříd a metod je popsána v referenci k API.
{% content-ref url="reference/prehled-trid.md" %}
[prehled-trid.md](reference/prehled-trid.md)
{% endcontent-ref %}

9
SUMMARY.md Normal file
View file

@ -0,0 +1,9 @@
# Table of contents
* [Vítejte!](README.md)
* [Quick Start](quick-start.md)
## Reference
* [Příklady](reference/priklady.md)
* [Přehled tříd](reference/prehled-trid.md)

44
quick-start.md Normal file
View file

@ -0,0 +1,44 @@
---
description: Jak začít s používáním API
---
# Quick Start
{% hint style="danger" %}
Využívání balíku je na vlastní nebezpečí, neručíme za škody způsobené používáním!
{% endhint %}
## Instalace balíku
Knihovna je hostována na [pub.dev](https://pub.dev/packages/canteenlib), instalace se provede jednoduše pomocí `dart pub add canteenlib`, pokud používáte Flutter pak `flutter pub add canteenlib`
## Vytvořit instanci
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.
```dart
import 'package:canteenlib/canteenlib.dart';
// ...
Canteen c = Canteen("https://kantyna.neco.cz");
// ...
```
## Přihlášení
Přihlášení za váš účet provedete pomocí metody `login`, parametry jsou uživatelské jméno a heslo.
{% hint style="info" %}
Knihovna používá hlavně [asynchronní funkce](https://dart.dev/codelabs/async-await), které vrací Future, doporučujeme používat uvnitř jiné asynchronní funkce s `await`.
{% endhint %}
```dart
// ...
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`.
## 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.

View file

@ -0,0 +1,4 @@
# Přehled tříd
Zde jsou zdokumentované všechny třídy, které lze uvnitř knihovny najít.

2
reference/priklady.md Normal file
View file

@ -0,0 +1,2 @@
# Příklady