Class DeviceProfileCallback

Represents a callback used to collect device profile data.

Hierarchy (view full)

FRCallback
- DeviceProfileCallback

Index

Constructors

Properties

Methods

getMessage isMetadataRequired isLocationRequired setProfile getType getInputValue setInputValue getOutputValue getOutputByName

Constructors

constructor

new DeviceProfileCallback(payload): DeviceProfileCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns DeviceProfileCallback
Overrides FRCallback.constructor
- Defined in fr-auth/callbacks/device-profile-callback.ts:22

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getMessage

getMessage(): string
Gets the callback's data.

Returns string
- Defined in fr-auth/callbacks/device-profile-callback.ts:29

isMetadataRequired

isMetadataRequired(): boolean
Does callback require metadata?

Returns boolean
- Defined in fr-auth/callbacks/device-profile-callback.ts:36

isLocationRequired

isLocationRequired(): boolean
Does callback require location data?

Returns boolean
- Defined in fr-auth/callbacks/device-profile-callback.ts:43

setProfile

setProfile(profile): void
Sets the profile.
Parameters
- profile: DeviceProfileData
Returns void
- Defined in fr-auth/callbacks/device-profile-callback.ts:50

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?): 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, selector?): 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?): 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, defaultValue): 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