Interface CreateAnalyticsLinkedSessionOptions`Experimental`

Options for createAnalyticsLinkedSession.

interface CreateAnalyticsLinkedSessionOptions {
    artifact: AnalyticsArtifact;
    binding?: AnalyticsLinkBindingOptions;
    historyLimit?: number;
    onCommit?: (commit: AnalyticsLinkCommit) => void;
    onWarning?: (
        message: string,
        detail?: Readonly<Record<string, unknown>>,
    ) => void;
    registry: AnalyticsAdapterRegistry;
    view: ExplorationViewController;
}

Index

Properties

artifact binding? historyLimit? onCommit? onWarning? registry view

Properties

`Readonly` `Experimental`artifact

artifact: AnalyticsArtifact

`Optional` `Readonly` `Experimental`binding

binding?: AnalyticsLinkBindingOptions

`Optional` `Readonly` `Experimental`historyLimit

historyLimit?: number

Commits retained for undo.

Default

`Optional` `Readonly` `Experimental`onCommit

onCommit?: (commit: AnalyticsLinkCommit) => void

Observe every commit (for telemetry or an app-level undo stack).

`Optional` `Readonly` `Experimental`onWarning

onWarning?: (
message: string,
detail?: Readonly<Record<string, unknown>>,
) => void

Observe adapter warnings.

`Readonly` `Experimental`registry

registry: AnalyticsAdapterRegistry

`Readonly` `Experimental`view

view: ExplorationViewController