Lingara Lingara 說明文件 學習指南 API 程式庫 App 建立 網頁版
語言: 粵語

整 Lingara App

呢頁係由英文翻譯過嚟嘅。如果兩個版本有出入,以英文頁為準。 睇英文頁

Lingara App 係一部由你自己行嘅伺服器。學習者安裝咗你個 App 之後,Lingara 會傳一個簽署過嘅請求去你部伺服器,你部伺服器就用一張卡片回應,然後 Lingara 用佢自己嘅風格畫出嗰張卡片。你嘅程式碼永遠唔會喺學習者部機度行,亦永遠睇唔到 Lingara 喺嗰度儲存咗啲乜。

對 Lingara 嚟講,一個 App 就係一個有 manifest 嘅 OAuth 用戶端。用戶端畀你個 App 一個身分。manifest 就講明佢張卡片可以喺邊度出現、佢要求睇乜嘢,同埋 Lingara 會將請求傳去邊度。

卡片喺邊度出現

你嘅 manifest 列出你張卡片可以填入嘅位置。總共有兩個:

  • plans.empty_detail:課程計畫畫面喺未揀任何計畫嘅時候嘅詳細資料窗格。只要個螢幕夠闊顯示到兩個窗格,網頁、Android 同 iOS 都會畫佢出嚟。
  • home.side:網頁首頁嘅側欄。

兩個位置都冇畫出嚟嘅地方,學習者可以喺「App」度用全螢幕開你個 App:網頁就喺控制台入面,Android 同 iOS 就喺「設定」入面。每個位置一次只會顯示一個 App。如果學習者為同一個位置安裝咗幾個 App,就由佢哋揀呢度顯示邊一個。

邊個可以安裝 App

而家一個 App 淨係可以由佢嘅擁有人安裝喺自己個帳戶度。其他人安裝暫時仲未開放。

你需要乜嘢

  • 一個 OAuth 用戶端,你喺控制台度建立。
  • 一部透過 HTTPS 回應 Lingara 請求嘅伺服器。
  • 下面其中一個 App 套件。套件會檢查每個請求嘅簽署,喺你送出卡片之前將佢限制喺 Lingara 嘅上限之內,再寫好個回覆。

快速入門會帶你行晒成個流程,由一個新嘅用戶端去到你自己帳戶上面嘅一張卡片。

安裝套件

喺下面揀你嘅語言。

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

整一個 App

  • 快速入門

    由一個新嘅 OAuth 用戶端,去到你個 App 張卡片出現喺你自己個帳戶度。

  • 卡片

    組成一張卡片嘅八種元素、Lingara 會套用嘅限制,同埋卡片失敗嗰陣學習者會見到乜嘢。

  • 情境資料同同意

    你個 App 可以逐個欄位知道學習者啲乜,同埋學習者點樣同意。

  • 導師提示

    你個 App 可以俾 Lingara 導師嘅一行字,同埋佢要經過嘅規則。