Lingara Lingara Documentatie Gidsen API Bibliotheken Apps Bouwen Webapp
Taal: Nederlands

Lingara-apps bouwen

Deze pagina is vertaald uit het Engels. Als de twee verschillen, is de Engelse pagina juist. Lees de Engelse pagina

Een Lingara-app is een server die jij draait. Wanneer een leerder je app heeft geïnstalleerd, stuurt Lingara je server een ondertekend verzoek, antwoordt je server met een kaart, en tekent Lingara die kaart in zijn eigen stijl. Je code draait nooit op het apparaat van de leerder en ziet nooit wat Lingara daar opslaat.

Voor Lingara is een app een OAuth-client met een manifest. De client geeft je app zijn identiteit. Het manifest zegt waar zijn kaart mag verschijnen, wat hij vraagt te zien en waar Lingara zijn verzoeken naartoe stuurt.

Waar een kaart verschijnt

Je manifest noemt de slots die je kaart mag vullen. Het zijn er twee:

  • plans.empty_detail: het detailpaneel van het scherm Lesplannen, zolang er geen plan is geselecteerd. Het wordt getekend op het web, Android en iOS zodra het scherm breed genoeg is om twee panelen te tonen.
  • home.side: de zijkolom van de homepagina op het web.

Waar geen van beide slots wordt getekend, opent de leerder je app schermvullend vanuit Apps: in de console op het web, en in Instellingen op Android en iOS. Elk slot toont één app tegelijk. Als een leerder meerdere apps voor hetzelfde slot heeft geïnstalleerd, kiest hij welke daar wordt getoond.

Wie een app kan installeren

Op dit moment kan een app alleen door zijn eigenaar worden geïnstalleerd, op diens eigen account. Installaties door anderen zijn nog niet beschikbaar.

Wat je nodig hebt

  • Een OAuth-client, die je in de console aanmaakt.
  • Een server die de verzoeken van Lingara via HTTPS beantwoordt.
  • Een van de app-kits hieronder. Een kit controleert de handtekening op elk verzoek, houdt je kaart binnen de limieten van Lingara voordat je hem verstuurt, en schrijft het antwoord.

De snelstart loopt het hele pad door, van een nieuwe client tot een kaart op je eigen account.

Een kit installeren

Kies hieronder je taal.

TypeScript

npm install @lingara/apps@0.1.0-alpha.6

Rust

cargo add lingara-apps@0.1.0-alpha.6 --features axum
cargo add axum@0.8
cargo add tokio --features macros,net,rt-multi-thread

Go

go get github.com/Spinning-Cat-Studios/lingara_app_framework_sdk/go@v0.1.0-alpha.6

Java

<dependency>
  <groupId>com.getlingara</groupId>
  <artifactId>lingara-apps-java</artifactId>
  <version>0.1.0-alpha.6</version>
</dependency>

Kotlin

implementation("com.getlingara:lingara-apps-kotlin:0.1.0-alpha.6")

Ruby

gem install lingara-apps -v 0.1.0-alpha.6

PHP

composer require spinningcatstudios/lingara-apps:0.1.0-alpha.6 spinningcatstudios/lingara:@alpha

Een app bouwen

  • Snelstart

    Van een nieuwe OAuth-client tot de kaart van je app op je eigen account.

  • Kaarten

    De acht elementen waaruit een kaart bestaat, de limieten die Lingara toepast en wat een leerder ziet als een kaart mislukt.

  • Context en toestemming

    Wat je app over een leerder te weten kan komen, veld voor veld, en hoe de leerder daarmee instemt.

  • De tutornotitie

    Eén regel die je app aan de tutor van Lingara kan meegeven, en de regels waar die doorheen gaat.