Skip to main content

LiveClientConfig

@ticketlayer/live


@ticketlayer/live / index / LiveClientConfig

Interface: LiveClientConfig

Defined in: client.ts:54

Extended by

Properties

apiVersion?

optional apiVersion?: string;

Defined in: client.ts:70

Override the dated API version sent as TL-Version.


baseUrl

baseUrl: string;

Defined in: client.ts:56

Base URL of a Live deployment (or the sales surface directly).


publishableKey?

optional publishableKey?: string;

Defined in: client.ts:66

For embeds/native: the channel's publishable key (tlpk_…).


sessionMode?

optional sessionMode?: "cookie" | "token";

Defined in: client.ts:64

Session transport:

  • 'cookie' (hosted web): the live_session httpOnly cookie travels automatically with credentials: 'include'; no token is held client-side.
  • 'token' (embeds / React Native / native): the session id is held by the SDK and sent as the X-Live-Session header.

tokenStorage?

optional tokenStorage?: LiveTokenStorage;

Defined in: client.ts:68

Token storage for 'token' session mode (defaults to in-memory).