SDK reference

Loading the Lia SDK, the Lia object's properties, how calls answer and fail, and an index of every method.

#Loading it

<script src="https://api.lialabs.org/sdk/lia-apps-v1.js"></script>

Load it from Lia, before your own scripts. It defines one global, window.Lia, once (loading it twice does nothing). It's plain JavaScript with no dependencies, and works with any framework or none. This page describes version 1.6.0.

In TypeScript, declare the global until there's a types package:

declare global {
  interface Window { Lia: any }
}
const Lia = window.Lia;

#How calls answer

• Most methods return a promise. It resolves with the answer described for each method, or rejects with an Error that has a code (and a message in English for you, not for players).
• Bad arguments reject too, with a code like bad_text, before anything reaches Lia. A few methods that don't return promises (Lia.inviteLink, Lia.on, the buttons' setters) throw instead.
• Outside the Lia app, every call rejects with not_in_lia. Lia.available tells you up front.
• Lia must answer within 20 seconds, or the call rejects with timeout. Calls that wait on the person (the pay sheet, ads, dialogs, the friend picker, the notifications ask, the scanner, the clipboard, Face ID, share) wait as long as it takes.

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" });
  }
}

Every code is listed in Error codes.

#Properties

Read these after Lia.init() has answered; before that they hold defaults. Most are kept current by Lia's events.

#Lia.isVersionAtLeast(version)

Whether the SDK is at least this version, for features added later.

if (Lia.isVersionAtLeast("1.3")) Lia.inviteFriend({ startParam: room });

Returns a boolean (not a promise).

#CSS variables

After init(), the SDK sets these on your page's root and keeps them current: Lia's theme (--lia-bg-color and the rest), --lia-color-scheme, --lia-viewport-height, --lia-safe-area-inset-* and --lia-content-safe-area-inset-*. See Look and feel.

#Every method

#Coming from Telegram

Lia's SDK follows Telegram's Mini Apps where it fits, so most ideas carry over: