Skip to main content

RootClient

RootClient = object

This type is your entry point to the Root client-side APIs. Root automatically creates an instance of this type and provides it for your use. You import the instance and access its properties.

Properties​

assets​

assets: RootClientAsset

Provides methods to download assets and images from the Root client.

device​

device: RootClientDevice

Provides information about the device your client is running on.

lifecycle​

lifecycle: RootClientLifecycle

Lifecycle events for your client-side component.

links: RootClientLink

Provides a method to create a shareable link that opens your app at a specific screen.

theme​

theme: RootClientTheme

Provides the current theme mode (light or dark) and an event to notify you when the user changes their theme.

users​

users: RootClientUser

Provides methods to retrieve user profiles and display the built-in profile popup.