SDK reference

Haptics, the QR scanner, the clipboard, links, Lia's own screens, Face ID and Touch ID, and the motion sensors.

#Haptics

#Lia.haptic(kind)

A tap the person feels. Resolves with null.

Lia.haptic("success");

An unknown kind plays "light". Each haptic is a round trip to Lia, so don't play one every frame of a game.

#Scanning and the clipboard

#Lia.scanQr(options)

Opens Lia's QR scanner over your app. Resolves with the code's text, or null if the person closed it.

const text = await Lia.scanQr({ text: "Scan the code on the table" });

Errors: bad_text, busy.

#Lia.copyText(text)

Copies text to the clipboard, and Lia says it's copied. Resolves with null.

Errors: bad_text, unsupported.

#Lia.readClipboard()

The text on the clipboard, or null. On iPhone, the phone asks the person first.

const pasted = await Lia.readClipboard();

#Links

#Lia.openLink(url, options)

Opens a web page. Your frame only shows your own pages, so use this for any other site.

Lia.openLink("https://example.com/terms");               // in Lia's in-app browser, over your app
Lia.openLink("https://example.com", { external: true }); // outside Lia, in the phone's browser

Resolves with null once the in-app browser is closed (or straight away for external). Errors: bad_url.

#Lia.openLiaLink(screen)

Opens one of Lia's own screens. Pages close your app first (asking, if you turned closing confirmation on) and open as themselves; sheets open over your app, which stays.

Lia.openLiaLink("mine"); // Lia's mining sheet, over your app

Resolves with { closed }: true if your app closed, false if it stayed (or the person chose to stay). Errors: unknown_screen, bad_screen.

#Face ID and Touch ID

#Lia.biometric

Ask the person to confirm it's them, with the phone's Face ID, Touch ID or fingerprint, before something sensitive in your app. Your app only learns whether they passed.

#Lia.biometric.init()

Whether the phone can do it. Resolves with { available, type }: available is true when the phone has it and it's set up; type is "face", "finger" or "unknown".

#Lia.biometric.authenticate(options)

Asks the person to confirm. Resolves with { authenticated }. If they can't use biometrics, the phone may offer its passcode instead.

const { available } = await Lia.biometric.init();
if (available) {
  const { authenticated } = await Lia.biometric.authenticate({ reason: "Confirm it's you to open your vault" });
}

Errors: unsupported, busy, bad_reason.

#Motion

Three sensors, each with start, stop, isStarted and its latest reading. Readings arrive as events while a sensor runs; it stops when your app closes. All three are optional on phones: start() fails with unsupported where there's none.

await Lia.deviceOrientation.start({ refreshRate: 50 });
Lia.on("deviceOrientationChanged", function (r) {
  steer(r.gamma); // tilting left and right
});
// later
Lia.deviceOrientation.stop();

#Lia.accelerometer

#Lia.gyroscope

The same as Lia.accelerometer, with x, y and z rotation rates.

#Lia.deviceOrientation

The same, with alpha, beta and gamma.