Class TermsAndConditionsCallback

Represents a callback used to collect acceptance of terms and conditions.

Hierarchy (view full)

FRCallback
- TermsAndConditionsCallback

Index

Constructors

Properties

Methods

getType getInputValue setInputValue getOutputValue getOutputByName getTerms getVersion getCreateDate setAccepted

Constructors

constructor

new TermsAndConditionsCallback(payload): TermsAndConditionsCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns TermsAndConditionsCallback
Overrides FRCallback.constructor
- Defined in fr-auth/callbacks/terms-and-conditions-callback.ts:21

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

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

getTerms

getTerms(): string
Gets the terms and conditions content.

Returns string
- Defined in fr-auth/callbacks/terms-and-conditions-callback.ts:28

getVersion

getVersion(): string
Gets the version of the terms and conditions.

Returns string
- Defined in fr-auth/callbacks/terms-and-conditions-callback.ts:35

getCreateDate

getCreateDate(): Date
Gets the date of the terms and conditions.

Returns Date
- Defined in fr-auth/callbacks/terms-and-conditions-callback.ts:42

setAccepted

setAccepted(accepted?): void
Sets the callback's acceptance.
Parameters
- accepted: boolean = true
Returns void
- Defined in fr-auth/callbacks/terms-and-conditions-callback.ts:50