Class AttributeInputCallback<T>

Represents a callback used to collect attributes.

Type parameters

T: string | number | boolean

Maps to StringAttributeInputCallback, NumberAttributeInputCallback and BooleanAttributeInputCallback, respectively

Hierarchy

FRCallback
- AttributeInputCallback

Index

Constructors

constructor

Properties

payload

Methods

Constructors

constructor

new AttributeInputCallback(payload: Callback): AttributeInputCallback

Overrides FRCallback.constructor
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:21
Parameters
- payload: Callback
  
  The raw payload returned by OpenAM
Returns AttributeInputCallback

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getFailedPolicies

getFailedPolicies(): PolicyRequirement[]

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:53
Gets the callback's failed policies.

Returns PolicyRequirement[]

getInputValue

getInputValue(selector?: number | string): unknown

Inherited from FRCallback.getInputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:35
Gets the value of the specified input element, or the first element if selector is not provided.

Parameters
- Default value selector: number | string = 0
  
  The index position or name of the desired element
Returns unknown

getName

getName(): string

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:32
Gets the attribute name.

Returns string

getOutputByName

getOutputByName<T>(name: string, defaultValue: T): T

Inherited from FRCallback.getOutputByName
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:65
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

getOutputValue

getOutputValue(selector?: number | string): unknown

Inherited from FRCallback.getOutputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:55
Gets the value of the specified output element, or the first element if selector is not provided.

Parameters
- Default value selector: number | string = 0
  
  The index position or name of the desired element
Returns unknown

getPolicies

getPolicies(): StringDict<any>

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:61
Gets the callback's applicable policies.

Returns StringDict<any>

getPrompt

getPrompt(): string

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:39
Gets the attribute prompt.

Returns string

getType

getType(): string

Inherited from FRCallback.getType
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:25
Gets the name of this callback type.

Returns string

isRequired

isRequired(): boolean

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:46
Gets whether the attribute is required.

Returns boolean

setInputValue

setInputValue(value: unknown, selector?: number | string | RegExp): void

Inherited from FRCallback.setInputValue
- Defined in packages/javascript-sdk/src/fr-auth/callbacks/index.ts:45
Sets the value of the specified input element, or the first element if selector is not provided.

Parameters
- value: unknown
- Default value selector: number | string | RegExp = 0
  
  The index position or name of the desired element
Returns void

setValidateOnly

setValidateOnly(value: boolean): void

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:69
Set if validating value only.

Parameters
- value: boolean
Returns void

setValue

setValue(value: T): void

- Defined in packages/javascript-sdk/src/fr-auth/callbacks/attribute-input-callback.ts:76
Sets the attribute's value.

Parameters
- value: T
Returns void