Class PingOneProtectInitializeCallback

Represents a callback used to initialize and start device and behavioral data collection.

Hierarchy (View Summary)

BaseCallback
- PingOneProtectInitializeCallback

Index

Constructors

Properties

Methods

getConfig getInputValue getOutputByName getOutputValue getType setClientError setInputValue

Constructors

constructor

new PingOneProtectInitializeCallback(
payload: Callback,
): PingOneProtectInitializeCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns PingOneProtectInitializeCallback
Overrides BaseCallback.constructor
- Defined in journey-client/src/lib/callbacks/ping-protect-initialize-callback.ts:18

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getConfig

getConfig(): | Record<string, string>
| {
    behavioralDataCollection: boolean;
    consoleLogEnabled: boolean;
    customHost: string;
    deviceAttributesToIgnore: string[];
    deviceKeyRsyncIntervals: number;
    disableHub: boolean;
    disableTags: boolean;
    enableTrust: boolean;
    envId: string;
    lazyMetadata: boolean;
}
Get callback's initialization config settings

Returns
    | Record<string, string>
    | {
        behavioralDataCollection: boolean;
        consoleLogEnabled: boolean;
        customHost: string;
        deviceAttributesToIgnore: string[];
        deviceKeyRsyncIntervals: number;
        disableHub: boolean;
        disableTags: boolean;
        enableTrust: boolean;
        envId: string;
        lazyMetadata: boolean;
    }
- Defined in journey-client/src/lib/callbacks/ping-protect-initialize-callback.ts:25

getInputValue

getInputValue(selector?: string | number): unknown
Gets the value of the specified input element, or the first element if selector is not provided.
Parameters
- selector: string | number = 0
  The index position or name of the desired element
Returns unknown
Inherited from BaseCallback.getInputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:32

getOutputByName

getOutputByName<T>(name: string, defaultValue: T): T
Gets the value of the first output element with the specified name or the specified default value.
Type Parameters
- T
Parameters
- name: string
  The name of the desired element
- defaultValue: T
Returns T
Inherited from BaseCallback.getOutputByName
- Defined in journey-client/src/lib/callbacks/base-callback.ts:62

getOutputValue

getOutputValue(selector?: string | number): unknown
Gets the value of the specified output element, or the first element if selector is not provided.
Parameters
- selector: string | number = 0
  The index position or name of the desired element
Returns unknown
Inherited from BaseCallback.getOutputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:52

getType

getType(): CallbackType
Gets the name of this callback type.

Returns CallbackType
Inherited from BaseCallback.getType
- Defined in journey-client/src/lib/callbacks/base-callback.ts:22

setClientError

setClientError(errorMessage: string): void
Parameters
- errorMessage: string
Returns void
- Defined in journey-client/src/lib/callbacks/ping-protect-initialize-callback.ts:53

setInputValue

setInputValue(value: unknown, selector?: string | number | RegExp): void
Sets the value of the specified input element, or the first element if selector is not provided.
Parameters
- value: unknown
- selector: string | number | RegExp = 0
  The index position or name of the desired element
Returns void
Inherited from BaseCallback.setInputValue
- Defined in journey-client/src/lib/callbacks/base-callback.ts:42