Interface AnalyticsAdapterRegistry`Experimental`

Registry of analytics presentation adapters.

interface AnalyticsAdapterRegistry {
    adapters: readonly AnalyticsPresentationAdapter[];
    get(adapterId: string): AnalyticsPresentationAdapter;
    register(adapter: AnalyticsPresentationAdapter): void;
    resolve(artifact: AnalyticsArtifact, options?: ResolveAnalyticsPresentationOptions): AnalyticsPresentationResolution;
    unregister(adapterId: string): boolean;
}

Index

Properties

Methods

get register resolve unregister

Properties

`Readonly` `Experimental`adapters

adapters: readonly AnalyticsPresentationAdapter[]

Registered adapters in preference order (the fallback is always last).

Methods

get

get(adapterId): AnalyticsPresentationAdapter
Experimental
Parameters
- adapterId: string
Returns AnalyticsPresentationAdapter
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/registry.ts:51

register

register(adapter): void
Experimental
Register an adapter ahead of the fallback. Throws on a duplicate id or an incompatible contract major version.
Parameters
- adapter: AnalyticsPresentationAdapter
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/registry.ts:49

resolve

resolve(artifact, options?): AnalyticsPresentationResolution
Experimental
Resolve the adapter that will present artifact. Never throws.
Parameters
- artifact: AnalyticsArtifact
- Optionaloptions: ResolveAnalyticsPresentationOptions
Returns AnalyticsPresentationResolution
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/registry.ts:53

unregister

unregister(adapterId): boolean
Experimental
Parameters
- adapterId: string
Returns boolean
- Defined in work/honua-sdk-js/honua-sdk-js/src/analytics/registry.ts:50