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 full)

FRCallback
- AttributeInputCallback

Index

Constructors

Properties

Methods

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

Constructors

constructor

new AttributeInputCallback<T>(payload): AttributeInputCallback<T>
Type Parameters
- T extends string | number | boolean
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns AttributeInputCallback<T>
Overrides FRCallback.constructor
- Defined in fr-auth/callbacks/attribute-input-callback.ts:25

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getName

getName(): string
Gets the attribute name.

Returns string
- Defined in fr-auth/callbacks/attribute-input-callback.ts:32

getPrompt

getPrompt(): string
Gets the attribute prompt.

Returns string
- Defined in fr-auth/callbacks/attribute-input-callback.ts:39

isRequired

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

Returns boolean
- Defined in fr-auth/callbacks/attribute-input-callback.ts:46

getFailedPolicies

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

Returns PolicyRequirement[]
- Defined in fr-auth/callbacks/attribute-input-callback.ts:53

getPolicies

getPolicies(): StringDict<any>
eslint-disable-next-line @typescript-eslint/no-explicit-any

Returns StringDict<any>
- Defined in fr-auth/callbacks/attribute-input-callback.ts:71

setValidateOnly

setValidateOnly(value): void
Set if validating value only.
Parameters
- value: boolean
Returns void
- Defined in fr-auth/callbacks/attribute-input-callback.ts:79

setValue

setValue(value): void
Sets the attribute's value.
Parameters
- value: T
Returns void
- Defined in fr-auth/callbacks/attribute-input-callback.ts:86

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