Class DeviceProfileCallback

Represents a callback used to collect device profile data.

Hierarchy (View Summary)

BaseCallback
- DeviceProfileCallback

Index

Constructors

Properties

Methods

getInputValue getMessage getOutputByName getOutputValue getType isLocationRequired isMetadataRequired setInputValue setProfile

Constructors

constructor

new DeviceProfileCallback(payload: Callback): DeviceProfileCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns DeviceProfileCallback
Overrides BaseCallback.constructor
- Defined in journey-client/src/lib/callbacks/device-profile-callback.ts:20

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

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

getMessage

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

Returns string
- Defined in journey-client/src/lib/callbacks/device-profile-callback.ts:27

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

isLocationRequired

isLocationRequired(): boolean
Does callback require location data?

Returns boolean
- Defined in journey-client/src/lib/callbacks/device-profile-callback.ts:41

isMetadataRequired

isMetadataRequired(): boolean
Does callback require metadata?

Returns boolean
- Defined in journey-client/src/lib/callbacks/device-profile-callback.ts:34

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

setProfile

setProfile(profile: DeviceProfileData): void
Sets the profile.
Parameters
- profile: DeviceProfileData
Returns void
- Defined in journey-client/src/lib/callbacks/device-profile-callback.ts:48