ping-identity
    Preparing search index...

    Type Alias DaVinciProtectModuleConfig

    Protect lifecycle module configuration nested under DaVinciModules.

    When present, the native DaVinci workflow registers the ProtectLifecycleModule at creation time. This wires behavioral-data initialization, pause-on-success, and resume-on-start hooks directly into the workflow lifecycle — no manual protect.start() / protect.pauseBehavioralData() calls are needed.

    Requires @ping-identity/rn-protect to be installed. If the package is absent at runtime the lifecycle module is silently skipped and collection does not run.

    type DaVinciProtectModuleConfig = {
        customHost?: string;
        deviceAttributesToIgnore?: string[];
        envId?: string;
        isBehavioralDataCollection?: boolean;
        isConsoleLogEnabled?: boolean;
        isLazyMetadata?: boolean;
        logger?: JourneyInstance;
        pauseBehavioralDataOnSuccess?: boolean;
        resumeBehavioralDataOnStart?: boolean;
    }
    Index

    Properties

    customHost? deviceAttributesToIgnore? envId? isBehavioralDataCollection? isConsoleLogEnabled? isLazyMetadata? logger? pauseBehavioralDataOnSuccess? resumeBehavioralDataOnStart?

    Properties

    customHost?: string

    Custom host URL for the Protect SDK signals endpoint.

    Maps to ProtectConfig.customHost on both platforms.

    deviceAttributesToIgnore?: string[]

    Device attributes to exclude from signal collection.

    Maps to ProtectConfig.deviceAttributesToIgnore on both platforms.

    envId?: string

    PingOne environment ID used by the Protect SDK.

    Maps to ProtectConfig.envId on both platforms.

    isBehavioralDataCollection?: boolean

    Whether to enable behavioral data collection.

    Maps to ProtectConfig.isBehavioralDataCollection. Defaults to true.

    isConsoleLogEnabled?: boolean

    Whether to enable console logging inside the Protect SDK.

    Maps to ProtectConfig.isConsoleLogEnabled. Defaults to false.

    isLazyMetadata?: boolean

    Whether to use lazy metadata loading.

    Maps to ProtectConfig.isLazyMetadata. Defaults to false.

    logger?: JourneyInstance

    Optional JavaScript logger instance for Protect operations.

    When provided, native collectProtect calls resolve this logger for operation-level logging. Falls back to the top-level DaVinci logger when absent. Must be created by @ping-identity/rn-logger (logger(...)).

    pauseBehavioralDataOnSuccess?: boolean

    Whether to pause behavioral data collection after a successful flow.

    Maps to ProtectLifecycleConfig.pauseBehavioralDataOnSuccess. Defaults to false.

    resumeBehavioralDataOnStart?: boolean

    Whether to resume behavioral data collection when the flow starts.

    Maps to ProtectLifecycleConfig.resumeBehavioralDataOnStart. Defaults to false.

    Settings

    Member Visibility

    On This Page

    Properties