Class OptiViewAdsSession

Owns one connector and one asynchronous session start. Retain this object outside React when the native player survives a UI unmount or reparent. Use this object's destroy(), not connector.destroy(), to finish playback.

Index

Constructors

Properties

connector ready

Accessors

Methods

destroy getSnapshot subscribe

Constructors

constructor

new OptiViewAdsSession(
connector: OptiViewAdsConnector,
config: SessionConfig,
): OptiViewAdsSession
Takes ownership of a fresh connector and schedules its single session start.
Parameters
- connector: OptiViewAdsConnector
- config: SessionConfig
Returns OptiViewAdsSession

Properties

`Readonly`connector

connector: OptiViewAdsConnector

The existing connector, also used for targeting updates and SDK events.

`Readonly`ready

ready: Promise<void>

Resolves when startup finishes; rejects with the original startup error.

Accessors

destroyed

get destroyed(): boolean

True as soon as destruction is requested, including after a failed start.

Returns boolean

Methods

destroy

destroy(): Promise<void>

Waits for pending startup, then destroys once. Repeated calls share the same promise.

Returns Promise<void>

`Readonly`getSnapshot

getSnapshot(): OptiViewAdsSessionSnapshot

Returns the same snapshot object until the lifecycle state changes.

Returns OptiViewAdsSessionSnapshot

`Readonly`subscribe

subscribe(listener: () => void): () => void
Observes state without taking ownership; unsubscribing does not end playback.
Parameters
- listener: () => void
Returns () => void