SDK referansı
SDK genel bakış
Sayfayı kopyala
Lia SDK'i yükleme, Lia nesnesinin özelliklerini, çağrıların cevaplanması ve başarısız olması, ve her yöntemin bir indeksi.
#Yükleniyor
<script src="https://api.lialabs.org/sdk/lia-apps-v1.js"></script>Kendi betiklerinizden önce Lia'dan yükleyin. Bir global tanımlar, window.Lia, bir kez (ikinci kez yükleme hiçbir şey yapmaz). Bu'bağımsız JavaScript ve herhangi bir framework ile çalışır veya hiç framework kullanmaz. Bu sayfa 1.8.0. sürümünü açıklar
TypeScript içinde, global bildirilir, buraya kadar's bir tür paketi:
declare global {
interface Window { Lia: any }
}
const Lia = window.Lia;#Aramalar nasıl cevaplanır
- Çoğu yöntem bir promise döndürür. Her yöntemin açıklamasında belirtilen cevapla çözülür, aksi takdirde bir hata ile reddedilir
Errorbir tane sahipcode(ve birmessageoyuncular için değil, sadece sizin için İngilizce. - Kötü argümanlar da reddeder, şu gibi bir kodla
bad_text, Lia'a ulaşmadan önce. Birkaç yöntem var ki'promisler döndürür (Lia.inviteLink,Lia.on, düğmeler' ayarlayıcılar) yerine atar. - Uygulama Lia dışında, her çağrı reddedilir
not_in_lia.Lia.availableönünde size söyler. - Lia 20 saniye içinde cevap vermelidir, veya çağrı reddedilir
timeout. Kişiye (ödeme sayfası, reklamlar, diyaloglar, arkadaş seçici, bildirim isteği, tarayıcı, Face ID, paylaşım) bekleyen çağrılar, ne kadar süreceği kadar bekler.
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" });
}
}Her kod Hata kodları.
#Özellikler
Bunları sonra oku Lia.init() varsayılanları tutar. Çoğu Lia tarafından güncellenir'olaylar.
| Özellik | Tür | O ne demek |
|---|---|---|
Lia.version | dize | SDK'sürüm, örneğin "1.8.0". |
Lia.available | mantıksal değer | true Lia uygulaması içinde. Skript yüklendiğinde bilinir. |
Lia.platform | dize | "ios" veya "android" ("unknown" önce init()). |
Lia.language | dize | Kişi's dili Lia'da: en, es, pt, fr, tr, ru, vi, id, fil, sw, hi, ar veya zh. Bkz. Dil. |
Lia.rtl | mantıksal değer | İşte bu dil sağdan sola okunuyor mu (Arapça). |
Lia.colorScheme | dize | "light" veya "dark". |
Lia.theme | nesne | Lia'u renkler, gibi bg_color, text_color ve kalanlar. Bkz. Lia'teması. |
Lia.viewport | nesne | { height, expanded }: sayfanız's yüksekliği piksel cinsinden ve bir sayfanın tam yükseklikte olup olmadığı. |
Lia.safeArea | nesne | { top, bottom, left, right }: telefon'güvenli alan px cinsinden. |
Lia.contentSafeArea | nesne | { top, bottom, left, right }: aynı zamanda Lia temiz olsun'tam ekran içinde yüzen kontroller. |
Lia.display | dize | Uygulamanız nasıl açıldı: "sheet", "full" veya "fullscreen". |
Lia.isFullscreen | mantıksal değer | İşte'kenar kenara şu anda. |
Lia.startParam | dize veya null | Açılış sırasında neyle açıldı: bir davet'bir bağlantı'veya bir bildirim's startParam. null Uygulamalar Merkezi'nden açıldığında. |
Lia.soundOn | mantıksal değer | İşte kişi uygulamanızı istiyor mu's sesler. |
Lia.notificationsAllowed | mantıksal değer | İşte bu kişi uygulamanızın onlara bildirim göndermesine izin veriyor mu. |
#Lia.isVersionAtLeast(version)
İşte SDK en az bu sürüm olmalı, daha sonra eklenen özellikler için.
if (Lia.isVersionAtLeast("1.3")) Lia.inviteFriend({ startParam: room });| Parametre | Tür | |
|---|---|---|
version | dize | Beğen "1.3" veya "1.3.0". |
Bir boolean döndürür (bir promise değil).
#CSS değişkenleri
Sonra init(), SDK bunları sayfanızda ayarlar'kök ve güncel tutar: Lia'teması (--lia-bg-color ve kalanlar), --lia-color-scheme, --lia-viewport-height, --lia-safe-area-inset-* ve --lia-content-safe-area-inset-*. Bkz. Görünüm ve his.
#Her yöntem
| Alan | Yöntemler |
|---|---|
| Başlatma ve yaşam döngüsü | Lia.init, Lia.ready, Lia.session, Lia.close, Lia.on, Lia.off, Lia.onPause, Lia.onResume |
| Ödemeler ve reklamlar | Lia.pay, Lia.charges, Lia.onCharge, Lia.showAd, Lia.showRewardedAd, Lia.showRewardedInterstitialAd, Lia.showInterstitialAd, Lia.onAd |
| Bildirimler ve davetler | Lia.requestNotifications, Lia.inviteFriend, Lia.inviteLink, Lia.share |
| Diyaloglar | Lia.confirm, Lia.showPopup, Lia.showAlert, Lia.showConfirm, Lia.toast |
| Düzen, renkler ve düğmeler | 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 |
| Cihaz | Lia.haptic, Lia.scanQr, Lia.copyText, Lia.readClipboard, Lia.openLink, Lia.openLiaLink, Lia.biometric, Lia.accelerometer, Lia.gyroscope, Lia.deviceOrientation |
| Puanlar ve depolama | Lia.submitScore, Lia.leaderboard, Lia.cloudStorage, Lia.deviceStorage, Lia.secureStorage |
#Telegram'dan geliyor
Lia's SDK Telegram takip eder's Mini Uygulamalar, uygun olduğu yerde, bu yüzden çoğu fikir taşınır:
| Telegram | Lia |
|---|---|
Telegram.WebApp.initData | Lia.init() ve sunucunuzun doğruladığı bir oturum belirteciyle cevaplar. POST /session/verify. |
themeParams, --tg-theme-* | Lia.theme, --lia-* (aynı isimler) |
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 (gerçekler, geri aramalar değil) |
showPopup, showAlert, showConfirm | Aynı, promise olarak |
openInvoice ve Yıldızlar | Lia.pay(productId), $LIA ile ödenir |
start_param | Lia.startParam |
#Web-uygulama analitiği
Lia.analytics (SDK 1.8) Lia Labs’nin OpenPanel projesindeki web uygulaması kullanımını isteğe bağlı olarak kaydeder. Şu anki iOS ve Android derlemeleriyle çalışır. Bu bir ayrı ayrı onayla yerel uygulamanın "Kullanım verilerini paylaş" anahtarından.
Sayfanız çağrıldığında Lia.ready(), SDK ekibi tarafından analitiklerin etkin olup olmadığı kontrol edilir ve bu uygulama için seçili bir tercih yoksa bir kez sorulur. Reddetmek hiçbir olay göndermez. Küçük bir gizlilik butonu, kişinin daha sonra tercihini değiştirmesine olanak tanır. Seçim, Lia’ın sunucusunda her oyuncu ve web uygulaması için saklanır. Onay alınmadan önce hiçbir analitik olayı kuyruğa alınamaz veya reddedildikten sonra tekrar oynatılmaz.
Lia.analytics.allowed: bu sayfanın şu anda izin olup olmadığını gösterir.Lia.analytics.requestConsent(): gizlilik tercihini tekrar açar ve cevap verirtruesadece izin sonra.Lia.analytics.disable(): bu sayfanın gönderimlerini hemen durdurur ve tercih edilmemiş durumu kaydeder.Lia.analytics.track(name, properties?): bir olayın gönderildiğini sorar; başarısızlıklar oyununuzu asla durdurmez. İsimler küçük harfler, rakamlar ve alt çizgiler kullanır, bir harfle başlar ve en fazla 48 karakter uzunluğundadır. Özellikler, en fazla 12 sayısal veya mantıksal değer içerebilir, küçük harfli tanımlayıcı anahtarlarla, en fazla 32 karakter uzunluğundadır.
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 });Çıkarılan SDK onaydan sonra açılış ve devamı kaydedilir. Oyun yolları için kendi statik olay isimlerinizi ekleyin. Olay isimleri olarak isimler, e-postalar, mesajlar, URLs, ücretsiz metin veya hesap tanımlayıcıları kullanmayın. Metin özellikleri reddedilir. Toplayıcı uygulama kimliğini ve canlı/test modunu ekler, imzalı oturumu kontrol eder, onayı tekrar kontrol eder, ekip analitikleri kapatma anahtarını saygı duyar ve oyuncu başına uygulama başına dakika başına 60 olaya sınırlar. Oyuncu profili kimliği, sayfa URLs, form değerleri veya kişinin IP adresi olmadan toplu olayları iletir.
İzleyici kullanır POST /api/web-analytics/consent ve /track tazeliğinde imzalı bir uygulama oturumu ile. Bu SDK'ya ait uç noktalar, geliştirici API anahtarı gerektirmez. OpenPanel kimlik bilgileri Lia'ün sunucusunda kalır.
Bu analiz yöntemleri, script etiketiyle yüklenen barındırılmış SDK’da bulunur. Davet ve lobi bağlantıları izin istemini otomatik açmaz; gizlilik düğmesi kullanılabilir durumda kalır.
Otomatik çeviri. İngilizce, doğru kaynaktır. İngilizce olarak oku