Interface Protect

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

interface Protect {
    getData: () => Promise<string | { error: string }>;
    pauseBehavioralData: () => void | { error: string };
    resumeBehavioralData: () => void | { error: string };
    start: () => Promise<void | { error: string }>;
}

Properties

getData pauseBehavioralData resumeBehavioralData start

Properties

getData

getData: () => Promise<string | { error: string }>

Type declaration

    • (): Promise<string | { error: string }>

    • Returns Promise<string | { error: string }>

      • Returns the device data or an error if PingOne Signals SDK failed to load

Async

Method

getData - Method to get the device data

pauseBehavioralData

pauseBehavioralData: () => void | { error: string }

Type declaration

    • (): void | { error: string }

    • Returns void | { error: string }

      • Returns an error if PingOne Signals SDK failed to load

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 | { error: string }

Type declaration

    • (): void | { error: string }

    • Returns void | { error: string }

      • Returns an error if PingOne Signals SDK failed to load

Method

resumeBehavioralData - Method to resume the behavioral data collection

Description

Resume the behavioral data collection

start

start: () => Promise<void | { error: string }>

Type declaration

    • (): Promise<void | { error: string }>

    • Returns Promise<void | { error: string }>

      • Returns an error if PingOne Signals SDK failed to load

Async

Method

start - Method to initialize and start the PingOne Signals SDK

Settings

Member Visibility

On This Page

Properties