Class PIProtect`Abstract`

PIProtect - Class to interact with the underlying PingOne Signals SDK

Index

Constructors

Methods

getData start pauseBehavioralData resumeBehavioralData getPauseBehavioralData getNodeConfig getPingProtectType setNodeClientError setNodeInputValue

Constructors

constructor

new PIProtect(): PIProtect
Returns PIProtect

Methods

`Static`getData

getData(): Promise<string>
Returns Promise<string>
- Returns the device data
Method
getData - Method to get the device data
- Defined in ping-protect.ts:59

`Static`start

start(options): Promise<void>
Parameters
- options: InitParams
  The init parameters
Returns Promise<void>
- Returns a promise
Method
start - Method to initialize and start the PingOne Signals SDK
- Defined in ping-protect.ts:68

`Static`pauseBehavioralData

pauseBehavioralData(): 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
- Defined in ping-protect.ts:91

`Static`resumeBehavioralData

resumeBehavioralData(): void
Returns void
Method
resumeBehavioralData - Method to resume the behavioral data collection

Description
Resume the behavioral data collection
- Defined in ping-protect.ts:100

`Static`getPauseBehavioralData

getPauseBehavioralData(step): boolean
Required when using the PingOne Protect Marketplace nodes, which has generic callbacks But, can be used for native nodes and/or either callback type
Parameters
- step: FRStep
Returns boolean
- Defined in ping-protect.ts:109

`Static`getNodeConfig

getNodeConfig(step): undefined | ProtectInitializeConfig
Parameters
- step: FRStep
Returns undefined | ProtectInitializeConfig
- Defined in ping-protect.ts:149

`Static`getPingProtectType

getPingProtectType(step): "initialize" | "evaluate" | "none"
Parameters
- step: FRStep
Returns "initialize" | "evaluate" | "none"
- Defined in ping-protect.ts:182

`Static`setNodeClientError

setNodeClientError(step, value): void
Parameters
- step: FRStep
- value: string
Returns void
- Defined in ping-protect.ts:204

`Static`setNodeInputValue

setNodeInputValue(step, value): void
Parameters
- step: FRStep
- value: string
Returns void
- Defined in ping-protect.ts:239