Class PingOneProtectInitializeCallback

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

Hierarchy (View Summary)

FRCallback
- PingOneProtectInitializeCallback

Index

Constructors

constructor

new PingOneProtectInitializeCallback(
payload: Callback,
): PingOneProtectInitializeCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns PingOneProtectInitializeCallback
Overrides FRCallback.constructor
- Defined in fr-auth/callbacks/ping-protect-initialize-callback.ts:21

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getType

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

Returns CallbackType
Inherited from FRCallback.getType
- Defined in fr-auth/callbacks/index.ts:26

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 FRCallback.getInputValue
- Defined in fr-auth/callbacks/index.ts:36

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 FRCallback.setInputValue
- Defined in fr-auth/callbacks/index.ts:46

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 FRCallback.getOutputValue
- Defined in fr-auth/callbacks/index.ts:56

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 FRCallback.getOutputByName
- Defined in fr-auth/callbacks/index.ts:66

getConfig

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

Returns
    | Record<string, unknown>
    | {
        envId: string;
        behavioralDataCollection: boolean;
        disableTags: boolean;
        universalDeviceIdentification: boolean;
        consoleLogEnabled: boolean;
        deviceAttributesToIgnore: string[];
        customHost: string;
        lazyMetadata: boolean;
        deviceKeyRsyncIntervals: number;
        enableTrust: boolean;
        disableHub: boolean;
        agentIdentification?: boolean;
        agentTimeout?: number;
        agentPort?: number;
    }
- Record<string, unknown>
- {
      envId: string;
      behavioralDataCollection: boolean;
      disableTags: boolean;
      universalDeviceIdentification: boolean;
      consoleLogEnabled: boolean;
      deviceAttributesToIgnore: string[];
      customHost: string;
      lazyMetadata: boolean;
      deviceKeyRsyncIntervals: number;
      enableTrust: boolean;
      disableHub: boolean;
      agentIdentification?: boolean;
      agentTimeout?: number;
      agentPort?: number;
  }
  - envId: string
    Required parameter
  - behavioralDataCollection: boolean
  - disableTags: boolean
  - universalDeviceIdentification: boolean
  - consoleLogEnabled: boolean
    Deprecated parameters
  - deviceAttributesToIgnore: string[]
  - customHost: string
  - lazyMetadata: boolean
  - deviceKeyRsyncIntervals: number
  - enableTrust: boolean
  - disableHub: boolean
  - OptionalagentIdentification?: boolean
  - OptionalagentTimeout?: number
  - OptionalagentPort?: number
- Defined in fr-auth/callbacks/ping-protect-initialize-callback.ts:28

setClientError

setClientError(errorMessage: string): void
Parameters
- errorMessage: string
Returns void
- Defined in fr-auth/callbacks/ping-protect-initialize-callback.ts:75

Class PingOneProtectInitializeCallback

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PingOneProtectInitializeCallback

Properties

payload

Methods

getType

Returns CallbackType

getInputValue

Parameters

Returns unknown

setInputValue

Parameters

Returns void

getOutputValue

Parameters

Returns unknown

getOutputByName

Type Parameters

Parameters

Returns T

getConfig

envId: string

behavioralDataCollection: boolean

disableTags: boolean

universalDeviceIdentification: boolean

consoleLogEnabled: boolean

deviceAttributesToIgnore: string[]

customHost: string

lazyMetadata: boolean

deviceKeyRsyncIntervals: number

enableTrust: boolean

disableHub: boolean

OptionalagentIdentification?: boolean

OptionalagentTimeout?: number

OptionalagentPort?: number

setClientError

Parameters

Returns void

Settings

On This Page

`Optional`agentIdentification?: boolean

`Optional`agentTimeout?: number

`Optional`agentPort?: number