SDK reference
SDK overview
Kopya ang pahina
Pag-load ng Lia SDK, ang mga properties ng Lia object, kung paano ang mga katanungan ay sumagot at nabigo, at isang index ng bawat paraan.
#Pag-load nito
<script src="https://api.lialabs.org/sdk/lia-apps-v1.js"></script>Mag-load ito mula sa Lia, bago ang iyong sariling scripts. Ito ay nagtatakda ng isang global, window.Lia, isang beses lamang (pag-load nito dalawa ay walang epekto). Ito'ng simpleng JavaScript na walang mga dependensiya, at gumagana sa anumang framework o walang framework. Ang pahinang ito ay naglalarawan ng bersyon 1.8.1.
Sa TypeScript, ipahayag ang global hanggang doon's isang types package:
declare global {
interface Window { Lia: any }
}
const Lia = window.Lia;#Paano ang mga tawag ay tumatanggap
- Ang mga paraan ay karaniwang nagbabalik ng isang pangako. Nag-uugnay sa sagot na inilarawan para sa bawat paraan, o nagrereject na may
Errorna may isangcode(at isangmessagesa Ingles para sa iyo, hindi para sa mga manlalaro). - Mga masamang argumento ay i-reject din, na may code tulad ng
bad_text, bago anumang bagay ay makarating sa Lia. Ang ilang mga paraan na hindi'hindi maaabot bumalik ng mga pangako (Lia.inviteLink,Lia.on, ang mga button' mga setter) ay ibinibigay sa halip. - Nasa labas ng Lia app), bawat pagtawag ay i-reject na may
not_in_lia.Lia.availablenagsasabi nang maaga. - Lia ay dapat sumagot sa loob ng 20 segundo, o ang shortcuts
timeout. Mga tawag na naghihintay sa tao (ang pay sheet, ads, dialogo, ang friend picker, ang mga kahilingan ng notification, ang scanner, ang clipboard, Face ID, share) ay naghihintay kahit gaano katagal.
try {
const result = await Lia.pay("extra-lives");
} catch (error) {
switch (error.code) {
case "cancelled": return; // they changed their mind
case "not_in_lia": return showOpenInLia();
default: Lia.toast("Something went wrong", { tone: "error" });
}
}Bawat code ay nasa listahan sa Mga code ng error.
#Mga Katangian
Basahin ang mga ito pagkatapos Lia.init() nag-utos; bago iyan ay may default. Ang marami ay panatilihin ang kapanahunan sa Lia'ang mga event.
| Katangian | Uri | Ano ito |
|---|---|---|
Lia.version | string | Ang SDK'ang bersyon, halimbawa "1.8.1". |
Lia.available | boolean | true sa loob ng Lia app. Alam agad kapag ang script ay nag-load. |
Lia.platform | string | "ios" o "android" ("unknown" bago init()). |
Lia.language | string | Ang tao'ng wika sa paraan na makakuha ng Lia. Tawagan ito pagkatapos en, es, pt, fr, tr, ru, vi, id, fil, sw, hi, ar o zh. Tingnan Wika. |
Lia.rtl | boolean | Kung ang wika ay mula kanan papalibot (Arabiko). |
Lia.colorScheme | string | "light" o "dark". |
Lia.theme | object | Lia'na mga kulay, tulad ng bg_color, text_color at ang natitira. Tingnan Lia'ang tema. |
Lia.viewport | object | { height, expanded }: ang iyong pahina'ng height, at |
Lia.safeArea | object | { top, bottom, left, right }: ang telepono's safe area sa px. |
Lia.contentSafeArea | object | { top, bottom, left, right }: din ay malinis ng Lia'ang floating controls sa fullscreen. |
Lia.display | string | Paano ang iyong app ay buksan: "sheet", "full" o "fullscreen". |
Lia.isFullscreen | boolean | Kung ito'ang edge to edge ngayon. |
Lia.startParam | string o null | Ano ang nagsimula nito: isang panukala's, isang link'naka-bukas o isang notification'ang startParam. null kapag buksan mula sa Apps Center. |
Lia.soundOn | boolean | Kung ang tao ay nais ang iyong app'ang sounds. |
Lia.notificationsAllowed | boolean | Kung ang tao ay pahintulutan ang iyong app na magpadala sa kanila ng mga notification. |
#Lia.isVersionAtLeast(version)
Kung ang SDK ay least na bersyon ito, para sa mga tampok na idinagdag pagkatapos.
if (Lia.isVersionAtLeast("1.3")) Lia.inviteFriend({ startParam: room });| Parameter | Uri | |
|---|---|---|
version | string | Like "1.3" o "1.3.0". |
Nagbabalik ng isang boolean (hindi isang pangako).
#CSS variables
Pagkatapos init(), ang SDK ay nagtatakda nito sa iyong pahina's root at panatilihin ito nang aktibo: Lia'ang tema (--lia-bg-color at ang natitira), --lia-color-scheme, --lia-viewport-height, --lia-safe-area-inset-* at --lia-content-safe-area-inset-*. Tingnan Tingnan at pakiramdam.
#Bawat paraan
| Lugar | Paraan |
|---|---|
| Startup at lifecycle | Lia.init, Lia.ready, Lia.session, Lia.close, Lia.on, Lia.off, Lia.onPause, Lia.onResume |
| Payments and ads | Lia.pay, Lia.charges, Lia.onCharge, Lia.showAd, Lia.showRewardedAd, Lia.showRewardedInterstitialAd, Lia.showInterstitialAd, Lia.onAd |
| Mga Notification at mga panata | Lia.requestNotifications, Lia.inviteFriend, Lia.inviteLink, Lia.share |
| Mga dialog | Lia.confirm, Lia.showPopup, Lia.showAlert, Lia.showConfirm, Lia.toast |
| Layout, kulay at mga button | Lia.expand, Lia.requestFullscreen, Lia.exitFullscreen, Lia.enableExpand, Lia.disableExpand, Lia.enableVerticalSwipes, Lia.disableVerticalSwipes, Lia.enableClosingConfirmation, Lia.disableClosingConfirmation, Lia.setBackgroundColor, Lia.setHeaderColor, Lia.mainButton, Lia.secondaryButton, Lia.backButton, Lia.settingsButton |
| Device | Lia.haptic, Lia.scanQr, Lia.copyText, Lia.readClipboard, Lia.openLink, Lia.openLiaLink, Lia.biometric, Lia.accelerometer, Lia.gyroscope, Lia.deviceOrientation |
| Mga marka at imbakan | Lia.submitScore, Lia.leaderboard, Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage |
#Mula sa Telegram
Lia's SDK ay sumunod sa Telegram's Mini Apps kung saan ito angkop, kaya ang karamihan ng mga ideya ay magkakasama:
| Telegram | Lia |
|---|---|
Telegram.WebApp.initData | Lia.init() mga sagot na may isang session token na ang iyong server ay kinokontrol na may POST /session/verify. |
themeParams, --tg-theme-* | Lia.theme, --lia-* (parehas na pangalang) |
MainButton, SecondaryButton, BackButton, SettingsButton | Lia.mainButton, Lia.secondaryButton, Lia.backButton, Lia.settingsButton |
HapticFeedback | Lia.haptic(kind) |
CloudStorage, DeviceStorage, SecureStorage | Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage (promises, hindi callbacks) |
showPopup, showAlert, showConfirm | Ang pareho, tulad ng mga pangako |
openInvoice at Stars | Lia.pay(productId), nagbabayad para sa grants, builders, app reward pools at $LIA |
start_param | Lia.startParam |
#Web-app analytics
Lia.analytics (SDK 1.8) nagre-record ng opsyonal na paggamit ng web-app sa Lia Labs' OpenPanel proyekto. Nagtatrabaho ito kasama ang kasalukuyang iOS at Android builds. Ito ay isang magkakaibang pagsang-ayon mula sa switch ng native app na 'Share usage data'.
Kapag ang iyong pahina ay tumawag Lia.ready(), ang SDK ay nagsusuri kung ang analytics ay naka-enable ng team at humihingi ng isang beses kung ang player na ito ay hindi pa nagpili para sa app na ito. Ang pagtanggi ay walang mga event. Isang maliit na button ng privacy ay nagbibigay ng pagkakataon sa tao na baguhin ang kanilang pagpili sa huli. Ang pagpili ay naka-store sa bawat player at web app sa server ng Lia. Walang analytics events ang inilagay bago ang pahintulot o ipinapakita muli pagkatapos ng pagtanggi.
Lia.analytics.allowed: kung ang pahina na ito ay may pahintulot ngayon.Lia.analytics.requestConsent(): buksan muli ang pagpili ng privacy at sumagottruelamang pagkatapos ng pahintulot.Lia.analytics.disable(): agad na tumigil sa pagpapadala at pag-iimbak ng opt-out sa pahina na ito.Lia.analytics.track(name, properties?): sumasagot kung ang isang event ay ipinadala; ang mga pagkabigo ay hindi nakakapigil sa iyong laro. Ang mga pangalan ay gumagamit ng lowercase letters, digits at underscores, nagsisimula sa isang letter, at ang maximum ay 48 characters. Ang mga properties ay pinapayagan ang hanggang 12 numeric o boolean values, na may lowercase identifier keys hanggang 32 characters.
await Lia.init();
Lia.ready();
// Only sends when the person has already agreed. Never prompt during a round.
await Lia.analytics.track("round_finished", { level: 3, score: 120, won: true });Ang SDK ay nagre-record ng pagbubukas at pagpapatuloy pagkatapos ng pahintulot. Magdagdag ng sariling pangalan ng pangyayari para sa mga antas ng laro. Huwag gamitin ang mga pangalan, email, mensahe, URLs, libreng teksto o mga identifier ng account bilang pangalan ng pangyayari. Ang mga text properties ay tinatanggihan. Ang collector ay idinagdag ang app id at live/test mode, sinuri ang signed session, sinuri muli ang pahintulot, sumunod sa analytics off switch ng team, at limitahan ang mga pangyayari sa 60 bawat manlalaro bawat app bawat minuto. Ito ay nagpapadala ng aggregate events nang walang player profile id, pahina URLs, form values o ang address ng tao na IP.
Ang tracker ay gumagamit ng POST /api/web-analytics/consent at /track kasama ang isang bagong signed app session. Ang mga endpoint na ito ay nasa pagmamay-ari ng SDK, at walang kailangan ng developer API key. Ang mga kredensyal ng OpenPanel nananatili sa server ng Lia.
Nasa naka-host na SDK na nilo-load gamit ang script tag ang mga paraang ito ng analytics. Hindi awtomatikong bumubukas ang pahintulot mula sa invite at lobby links; mananatiling magagamit ang privacy button.
Awtomatikong isinalin. Ang English ay ang source of truth. Basahin sa Ingles