Interface Protect

Protect - Interface for methods to interact with the PingOne Signals SDK

interface Protect {
    getData: () => Promise<string>;
    getNodeConfig: (step: FRStep) => undefined | ProtectInitializeConfig;
    getPauseBehavioralData: (step: FRStep) => boolean;
    getProtectType: (step: FRStep) => ProtectType;
    pauseBehavioralData: () => void;
    resumeBehavioralData: () => void;
    setNodeClientError: (step: FRStep, value: string) => void;
    setNodeInputValue: (step: FRStep, value: string) => void;
    start: () => Promise<void>;
}

Properties

getData getNodeConfig getPauseBehavioralData getProtectType pauseBehavioralData resumeBehavioralData setNodeClientError setNodeInputValue start

Properties

getData

getData: () => Promise<string>

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      • Returns the device data

Async

Method

getData - Method to get the device data

getNodeConfig

getNodeConfig: (step: FRStep) => undefined | ProtectInitializeConfig

Type declaration

Method

getNodeConfig - Method for getting the Protect intitialization config options

getPauseBehavioralData

getPauseBehavioralData: (step: FRStep) => boolean

Type declaration

    • (step: FRStep): boolean

    • Parameters

      • step: FRStep

        A journey step

      Returns boolean

Method

getPauseBehavioralData

Description

  • Required when using Ping Protect Marketplace nodes

getProtectType

getProtectType: (step: FRStep) => ProtectType

Type declaration

    • (step: FRStep): ProtectType

    • Parameters

      • step: FRStep

        A journey step

      Returns ProtectType

      • The type of step in the Protect flow

Method

getPingProtectType - Method for getting the type of step in the Protect flow

pauseBehavioralData

pauseBehavioralData: () => void

Type declaration

    • (): void

    • Returns void

Method

pauseBehavioralData - Method to pause the behavioral data collection

Description

Pause the behavioral data collection only; device profile data will still be collected

resumeBehavioralData

resumeBehavioralData: () => void

Type declaration

    • (): void

    • Returns void

Method

resumeBehavioralData - Method to resume the behavioral data collection

Description

Resume the behavioral data collection

setNodeClientError

setNodeClientError: (step: FRStep, value: string) => void

Type declaration

    • (step: FRStep, value: string): void

    • Parameters

      • step: FRStep

        A journey step

      • value: string

        The error message to set

      Returns void

Method

setNodeClientError - Method for setting an error on a Ping Protect Marketplace node

setNodeInputValue

setNodeInputValue: (step: FRStep, value: string) => void

Type declaration

    • (step: FRStep, value: string): void

    • Parameters

      • step: FRStep

        A journey step

      • value: string

        The value to set the input to

      Returns void

Method

setNodeInputValue - Method for setting an input value on a Ping Protect Marketplace node

start

start: () => Promise<void>

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

      • Returns a promise

Async

Method

start - Method to initialize and start the PingOne Signals SDK

Settings

Member Visibility

On This Page

Properties