Configuration Object

You configure Arkose Protect or Arkose Detect by setting attribute values for the configuration object. This is done using the setConfig method on the Arkose object passed to the setup function, as shown here. If any of the callback functions are not invoking as expected, contact your Sales Rep or Sales Engineer. Note that there are separate examples for Arkose Detect and Arkose Protect.

Note that four callbacks, , onCompleted, onError, onFailed, and onResize, return a response object, which contains information that usually needs to be further processed or presented to users by your code. See Response Object (onCompleted, onError, onFailed, onResize) for more details.

// The Callback Function
function setupEnforcement(myEnforcement) {
  myEnforcement.setConfig({
    data: {},
    language: 'ar',
    onCompleted: (response) => {},
    onHide: () => {},
    onReady: () => {},
    onReset: () => {},
    onShow: () => {},
    onShown: () => {},
    onSuppress: () => {},
    onError: (response) => {},
    onFailed:(response) => {},
    onResize: (response) => {},
    selector: '#my-submit-button',
    accessibilitySettings: {
      lockFocusToModal: true 
    }
  });
}

// The Callback Function
function setupDetect(myDetect) {
  myDetect.setConfig({
    data: {},
    onCompleted: (response) => {},
    onHide: () => {},
    onReady: () => {},
    onShow: () => {},
    onSuppress: () => {},
    onError: (response) => {},
    selector: '#my-submit-button'
    }
  });
}

This table shows the settable setConfig attributes, their types, brief description and to which product they are applicable.

Method	Type	Description	Applicable Product
`data`	Object	Encrypted arbitrary JSON data sent to Arkose at the very start of a sessions classification. This is how Arkose Data Exchange data is sent to the API.	Arkose Detect Arkose Protect
`language`	String	Language code. See Supported Languages for our supported values. Browser settings control Arkose Platform's language, but can be overridden by using this setting to pass your desired language's entire Locale ID String.	Arkose Protect
`onCompleted(response)`	Function	Callback function invoked when applicable detection and/or enforcement has been successfully completed. A Response Object is passed to this function. See Response Object (onCompleted, onError, onFailed, onResize) for details.	Arkose Detect Arkose Protect
`onHide`	Function	Callback function invoked when the detection and/or enforcement view is hidden. For example, this happens after detection and/or enforcement is completed. It's also triggered during enforcement if the user clicks the close button. Note that the close button only appears when in Lightbox mode.	Arkose Detect Arkose Protect
`onReady`	Function	Callback function invoked when the detection or enforcement is ready. The Enforcement cannot be triggered before this event. You may want to disable the UI you are protecting until this event has been triggered.	Arkose Detect Arkose Protect
`onShow`	Function	A callback invoked when detection and/or enforcement is loading. The function is also invoked when an enforcement is re-displayed (e.g. if the user closes the view and tries to continue). Note that the close button only appears when in Lightbox mode.	Arkose Detect Arkose Protect
`onShown`	Function	Only applicable to Arkose Protect. A callback invoked when the Enforcement Challenge is displayed. The `onShown` method will only be invoked the first time an Enforcement Challenge is displayed.	Arkose Protect
`onSuppress`	Function	A callback invoked when the detection and/or enforcement is running and the Arkose Platform is analyzing the user intent.	Arkose Detect Arkose Protect
`onError(response)`	Function	A callback invoked when an error occurs in loading of the detection and/or enforcement. A Response Object is passed to this function. See below for details about the Response Object.	Arkose Detect Arkose Protect
`onFailed(response)`	Function	Callback function invoked when a challenge has failed (the user has failed the challenge multiple times and is not allowed to continue the session). A Response Object is passed to this function. See below for details about the Response Object.	Arkose Protect
`onResize(response)`	Function	A callback invoked when a sizing event occurs in the loading of the challenge. A Response Object is passed to this function. See below for details about the Response Object.	Arkose Protect
`onReset`	Function	A callback invoked after the enforcement resets. Typically occurs after a challenge has been successfully answered. Note that your implementation should not call the `reset()` function in this callback.	Arkose Protect
`selector`	String	The element selector (e.g. `#my-submit-button`) for either triggering the detection to display as a modal, or where the detection will appear inline on the page. This parameter is dependent on how the mode parameter has been configured."	Arkose Protect
`mode`	String	Sets if the Enforcement Challenge will be shown as a modal or within the selected element. Allowed values are lightbox and inline, where the default is lightbox, which indicates display as modal.	Arkose Protect
`accessibilitySettings`	Object	Contains settings for accessibility that need to make changes implementing websites markup. `lockFocusToModal` If enabled and `mode` is set to `lightbox`, `aria-hidden=true` will be added to sibling elements of the Enforcement Challenge container. This is to ensure that users employing Assistive Technology do not accidentally leave the lightbox before interacting with the challenge.	Arkose Protect
`styleTheme`	String	Sets theme to existing style manager built theme with the given name. If not set, the default theme is used.	Arkose Protect