Sessions

// access
nexus.sessions

IdentifyOptionsCopy Anchor Link

emailCopy Anchor Link

email?: string

nameCopy Anchor Link

name?: string

phoneCopy Anchor Link

phone?: string

End-user phone number (E.164 recommended).

traitsCopy Anchor Link

traits?: Record<string, unknown>

NexusSessionsCopy Anchor Link

The sessions spine — names the end-user and starts/refreshes the journey.

NexusSessionsCopy Anchor Link

new NexusSessions(http: NexusHttp, id: NexusIdentity, cfg: ResolvedConfig)

Parameters

Returns NexusSessions

identify()Copy Anchor Link

async identify(distinctId: string, options: IdentifyOptions = {}): Promise<void>

Identify the current end-user; all later telemetry is attributed to it.

Parameters

track()Copy Anchor Link

async track(context?: Record<string, unknown>): Promise<string | null>

Start/refresh the active session; returns the server session id.

Parameters

Returns Promise<string | null>

reset()Copy Anchor Link

reset(): void

Forget the user (e.g. on logout) and start a fresh session.