JavaScript Client

Captcha

Methods

constructor(options)

Parameters:
optionsCaptchaOptions(required)

getId()

Parameters:
none
Return Value:
idstring

CAPTCHA id

getUserAttempt()

Parameters:
none
Return Value:
userAttemptstring

key for the CAPTCHA

Other types

CaptchaOptions

{
    "elementId": "captcha",
    "captchaId": "ap9vHqD-MWEZj_GueOoFhqoTEbRY68LMv0rQJ9bXPcPV4BsdHqeg3uTt3z-6vaNYz",
    "type": "BASIC",
    "displayInformation": {
        "caption": "Type all of the characters",
    }
}

Attributes

captchaIdstring(required)

the CAPTCHA id

displayInformationJavaScript object(required)

information supplied by NetToolKit's Shibboleth service about how the CAPTCHA should be rendered (to be passed to the JavaScript client)

elementIdstring(required)

the id of the element the CAPTCHA be attached to

typeCaptcha.type(required)
inputElementElement(optional)

a custom input for CAPTCHAs with text input. Must be an input element or an element with a single input element as a child.

onMountfunction(optional)

A function to be called after the CAPTCHA has been added to the DOM.

Constants

type

BASIC

DATE

MATH

NAVAL_COMMAND

PATH

SPLIT

SPOTTER

SUBSTRING