Skip to content
Docs
Reference

Interface: NativeLiveClientOptions

Interface: NativeLiveClientOptions in @ticketlayer/live.

@ticketlayer/live


@ticketlayer/live / native / NativeLiveClientOptions

Defined in: native/index.ts:59

Properties#

apiUrl#

apiUrl: string;

Defined in: native/index.ts:61

Base URL of the Live API, e.g. https://api.live.ticketlayer.com. Required: there is no page to default from.


apiVersion?#

optional apiVersion?: string;

Defined in: native/index.ts:79

Override the dated API version sent as TL-Version.


checkoutBaseUrl#

checkoutBaseUrl: string;

Defined in: native/index.ts:65

Origin of the hosted checkout (the HBO deployment serving /embed/checkout). Required.


publishableKey#

publishableKey: string;

Defined in: native/index.ts:63

The channel's publishable key (tlpk_...). Identifies the channel and authorises catalogue reads.


resume?#

optional resume?: boolean;

Defined in: native/index.ts:77

Resume the stored session on start (default true): GET /session with the stored token rehydrates the cart and sign-in state. A token the API rejects is removed from storage and the client starts lazily instead.


tokenStorage?#

optional tokenStorage?: NativeTokenStorage;

Defined in: native/index.ts:71

Where the Live session token lives between app launches. Use secureStoreStorage(SecureStore) on Expo or asyncStorageStorage(AsyncStorage). Defaults to in-memory storage, which forgets the session on restart.