Class ReCaptchaEnterpriseCallback

Represents a callback used to integrate reCAPTCHA.

Hierarchy (View Summary)

BaseCallback
- ReCaptchaEnterpriseCallback

Index

Constructors

Properties

Methods

getApiUrl getElementClass getInputValue getOutputByName getOutputValue getSiteKey getType setAction setClientError setInputValue setPayload setResult

Constructors

constructor

new ReCaptchaEnterpriseCallback(payload: Callback): ReCaptchaEnterpriseCallback
Parameters
- payload: Callback
  The raw payload returned by OpenAM
Returns ReCaptchaEnterpriseCallback
Overrides BaseCallback.constructor
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:22

Properties

payload

payload: Callback

The raw payload returned by OpenAM

Methods

getApiUrl

getApiUrl(): string
Get the api url

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

getElementClass

getElementClass(): string
Get the class name

Returns string
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:42

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

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

getSiteKey

getSiteKey(): string
Gets the reCAPTCHA site key.

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

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

setAction

setAction(action: string): void
Set the recaptcha action
Parameters
- action: string
Returns void
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:69

setClientError

setClientError(error: string): void
Set client client error
Parameters
- error: string
Returns void
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:55

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

setPayload

setPayload(payload: unknown): void
Set the recaptcha payload
Parameters
- payload: unknown
Returns void
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:62

setResult

setResult(result: string): void
Sets the reCAPTCHA result.
Parameters
- result: string
Returns void
- Defined in journey-client/src/lib/callbacks/recaptcha-enterprise-callback.ts:48