OptiView Ads SDK for React Native
    Preparing search index...

    Interface OptiViewAdsExternalVendorsApi

    Async API shared by the native and web external-vendor readers.

    interface OptiViewAdsExternalVendorsApi {
        addEventListener(
            event: "externalvendorconfigurationchange",
            handler: OptiViewAdsEventHandler<"externalvendorconfigurationchange">,
        ): Promise<void>;
        destroy(): Promise<void>;
        exportDiagnostics(): Promise<DiagnosticReport>;
        getExternalVendorConfiguration(): Promise<ExternalVendorConfiguration[]>;
        getExternalVendorConfiguration(
            provider: string,
        ): Promise<ExternalVendorConfiguration | undefined>;
        offDiagnostic(handler: DiagnosticHandler): Promise<void>;
        onDiagnostic(handler: DiagnosticHandler): Promise<void>;
        removeEventListener(
            event: "externalvendorconfigurationchange",
            handler: OptiViewAdsEventHandler<"externalvendorconfigurationchange">,
        ): Promise<void>;
        start(): Promise<void>;
        stop(): Promise<void>;
        updateAssetParameterMacros(
            macros: AssetParameterMacroUpdates,
        ): Promise<void>;
        updateAssetParameters(parameters: Record<string, string>): Promise<void>;
    }

    Implemented by

    Index
    destroy getExternalVendorConfiguration start stop updateAssetParameterMacros updateAssetParameters
    addEventListener removeEventListener
    exportDiagnostics offDiagnostic onDiagnostic

    • Stop polling, clear entries, and release listeners.

      Returns Promise<void>

    • Return all resolved configurations in manifest order.

      Returns Promise<ExternalVendorConfiguration[]>

    • Return one resolved configuration using an exact provider match.

      Parameters

      • provider: string

      Returns Promise<ExternalVendorConfiguration | undefined>

    • Fetch the initial manifest and begin polling when configured.

      Returns Promise<void>

    • Stop polling and clear the current entries.

      Returns Promise<void>

    • Replace application parameters used to resolve each configuration.

      Parameters

      • parameters: Record<string, string>

      Returns Promise<void>

    • Subscribe to external-vendor configuration changes.

      Parameters

      Returns Promise<void>

    • Remove a configuration-change listener.

      Parameters

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Lifecycle
    Events
    Diagnostics