On This Page
REST API
Configuring the Android SDK
Get the instance of the Cardinal object by
Cardinal.getInstance()
. Use the
default configuration options. See the example below to complete
Cardinal.configure()
. For more details on configuration, refer to the configuration options table
after the example.
private Cardinal cardinal = Cardinal.getInstance(); @Override protected void onCreate(Bundle savedInstanceState) { CardinalConfigurationParameters cardinalConfigurationParameters = new CardinalConfigurationParameters(); cardinalConfigurationParameters.setEnvironment(CardinalEnvironment.STAGING); cardinalConfigurationParameters.setTimeout(8000); JSONArray rType = new JSONArray(); rType.put(CardinalRenderType.OTP); rType.put(CardinalRenderType.SINGLE_SELECT); rType.put(CardinalRenderType.MULTI_SELECT); rType.put(CardinalRenderType.OOB); rType.put(CardinalRenderType.HTML); cardinalConfigurationParameters.setRenderType(rType); cardinalConfigurationParameters.setUiType(CardinalUiType.BOTH); UiCustomization yourUICustomizationObject = new UiCustomization(); cardinalConfigurationParameters.setUICustomization(yourUICustomizationObject); cardinal.configure(this,cardinalConfigurationParameters); }
Method | Description | Default Values |
---|---|---|
setEnableDFSync (boolean enableDFSync) | On setting true, onSetupCompleted is called after the
collected device data is sent to the server. | False |
setEnableQuickAuth (boolean enableQuickAuth) | Sets enable quick auth false. | False |
setEnvironment(Setting up mobile SDK - Android- V
2.1#CardinalEnvironment environment) | Sets the environment to which the SDK must connect. | CardinalEnvironment. PRODUCTION |
setProxyAddress(java.lang. String proxyAddress) | Sets the proxy to which the SDK must connect. | “ “ |
setRenderType(org.json. JSONArray renderType) | Sets renderLists all user interface types that the device
supports for displaying specific challenge user interfaces within the
SDK. | JSONArray rType = new JSONArray(); rType.put(Cardinal RenderType.OTP); rType.put(Cardinal RenderType.SINGLE_SELECT); rType.put(Cardinal RenderType.MULTI_SELECT); rType.put(Cardinal RenderType.OOB); rType.put(Cardinal RenderType.HTML); |
setTimeout(int timeout) | Sets the maximum amount of time (in milliseconds) for all
exchanges. | 8000 |
setUICustomization (UiCustomization UI Customization) | Sets UICustomization | Device Default Values |
setUiType(CardinalUiType uiType) | Sets all user interface types that the device supports for
displaying specific challenge user interfaces within the SDK. | CardinalUiType.BOTH |