Class AttributeInputCallback<T>

Represents a callback used to collect attributes.

Typeparam

T Maps to StringAttributeInputCallback, NumberAttributeInputCallback and BooleanAttributeInputCallback, respectively

Type Parameters

T extends string | number | boolean

Hierarchy (View Summary)

BaseCallback
- AttributeInputCallback

Index

Constructors

Properties

Methods

getFailedPolicies getInputValue getName getOutputByName getOutputValue getPolicies getPrompt getType isRequired setInputValue setValidateOnly setValue

Constructors

constructor

new AttributeInputCallback<T extends string | number | boolean>(
payload: Callback,
): AttributeInputCallback<T>
Type Parameters
- T extends string | number | boolean
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns AttributeInputCallback<T>
Overrides BaseCallback.constructor
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:22

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getFailedPolicies

getFailedPolicies(): PolicyRequirement[]
Gets the callback's failed policies.

Returns PolicyRequirement[]
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:50

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

getName

getName(): string
Gets the attribute name.

Returns string
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:29

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

getPolicies

getPolicies(): Record<string, unknown>
Gets the callback's applicable policies.

Returns Record<string, unknown>
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:64

getPrompt

getPrompt(): string
Gets the attribute prompt.

Returns string
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:36

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

isRequired

isRequired(): boolean
Gets whether the attribute is required.

Returns boolean
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:43

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

setValidateOnly

setValidateOnly(value: boolean): void
Set if validating value only.
Parameters
- value: boolean
Returns void
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:71

setValue

setValue(value: T): void
Sets the attribute's value.
Parameters
- value: T
Returns void
- Defined in journey-client/src/lib/callbacks/attribute-input-callback.ts:78