kony.localAuthentication Namespace

---

The API is used to authenticate the user.

Note: You can use this API for both the Touch ID and Face ID features. For information about how to detect whether a device supports either the Touch ID or Face ID feature, refer the getBiometryType API.

Note: Call the kony.localAuthentication.authenticate API only if the kony.localAuthentication.getStatusForAuthenticationMode API returns the success status code (5000).

Syntax

kony.localAuthentication.authenticate(
    authenticationMode,
    statusCallback,
    configMap)

Input Parameters

Parameter	Description
authenticationMode	Specifies the authentication mode for which the status is requested. The data type is constant. For more information on authentication modes, see Authentication Modes.
statusCallBack (status, message)	A callback conveys the status of the authentication with appropriate status and message. The default value is nil. For status code, see the Status Codes section. Note: For Android, the statusCallBack parameter returns only the 5002 status code; this status code is returned when the authentication is canceled by a user.
configMap	Specifies the configuration dictionary for the specified authentication mode. The configMap parameter uses keys listed in the table below. promptMessage: Message to be displayed on the screen. This is applicable only for the iOS platform. Ignored in the Android platform. fallbackTitle: Allows you to edit the default text, "Enter Password" on the native pop-up, which is displayed when user authentication fails using Touch ID or Face ID. This is applicable only for the iOS platform.

Example

function statusCB(status, message) {  
    if(status == 5000)    {     
        kony.ui.Alert({
            message: "AUTHENTICATION SUCCESSFULL",
            alertType: constants.ALERT_TYPE_INFO,
            yesLabel: "Close"
        }, {});   
    }  
    else    {     
        var messg = status + message;     
        kony.ui.Alert({
            message: messg,
            alertType: constants.ALERT_TYPE_INFO,
            yesLabel: "Close"
        }, {});  
    }
}

function authUsingTouchID() {  
    var configMap = {
        "promptMessage": "PLEASE AUTHENTICATE USING YOUR TOUCH ID",                   
        "fallbackTitle": "Please enter your Password"
    };  
    kony.localAuthentication.authenticate(constants.LOCAL_AUTHENTICATION_MODE_TOUCH_ID, statusCB, configMap);
}

Return Values

No

Remarks

The authentication mode with the Touch ID (LOCAL_AUTHENTICATION_MODE_TOUCH_ID) requires a message to display that prompts a user to provide authentication. The key to be used is “promptMessage”. You can also pass another key-value pair, fallbackTitle in the configMap parameter to customize the label title of the "Enter Password" button.

Below is a sample configMap:

var configMap = {"promptMessage" : "PLEASE AUTHENTICATE USING YOUR TOUCH ID",
                 "fallbackTitle" : "Please enter your Password"};

Note: Depending on the type of authentication available, the promptMessage is either PLEASE AUTHENTICATE USING YOUR TOUCH ID or PLEASE AUTHENTICATE USING YOUR FACE ID.

Note: If you assign an empty string, “ ” to the fallbackTitle key, the Enter Password button will be hidden. If the fallbackTitle key is not defined in the configMap parameter, the default (Enter Password) value is displayed.

Platform Availability

• iOS
• Android

---

---

This API differentiates whether a device supports either the Touch ID or Face ID feature. The kony.localAuthentication.getBiometryType API is available from iOS 11.

Syntax

kony.localAuthentication.getBiometryType()

Example

function getBiometryTypeOfDevice() {
    var promptMessage = "Sign in with ";
    switch (kony.localAuthentication.getBiometryType()) {
        case constants.BIOMETRY_TYPE_NONE:
            // Handle the case if the device doesn't support any biometryType
            break;
        case constants.BIOMETRY_TYPE_TOUCHID:
            promptMessage += "TouchID";
            break;
        case constants.BIOMETRY_TYPE_FACEID:
            promptMessage += "FaceID";
            break;
        case constants.BIOMETRY_TYPE_UNDEFINED:
            // Handle the case if the device is not a iOS11 device or later
            break;
    }
}

Return Values

Return Value	Description
constants.BIOMETRY_TYPE_NONE	If there is no biometric authentication in the device.
constants.BIOMETRY_TYPE_TOUCHID	If the device supports Touch ID authentication.
constants.BIOMETRY_TYPE_FACEID	If the device supports Face ID authentication.
constants.BIOMETRY_TYPE_UNDEFINED	If this API is called on the device with OS earlier than iOS11.

 

Remarks

Face ID is the new biometric authentication that Apple has introduced with iPhoneX. This API will help to customize the prompt message in kony.localAuthentication.authenticate. Depending on the type of authentication available, the prompt message is Sign in with FaceID or Sign in with TouchID.

Platform Availability

• iOS

---

---

The API cancels the current authentication process.

Syntax

kony.localAuthentication.cancelAuthentication()

Example

var cancelButton = kony.ui.Button({
    onClick: btnOnClick
});
function btnOnClick() {
    kony.localAuthentication.cancelAuthentication()
}

Return Values

Return Value	Description
status	The 5002 status code is returned indicating the authentication is canceled.

 

Remarks

The API is available only for the Android platform. You can use this API for the Cancel button placed in the authentication dialog box. When user taps the Cancel button, the API is called to cancel the authentication process.

Platform Availability

• Android

---

---

The API returns the status of the authentication mode.

Note: You can use this API for both the Touch ID and Face ID features. For information about how to detect whether a device supports either the Touch ID or Face ID feature, refer the getBiometryType API.

Syntax

kony.localAuthentication.getStatusForAuthenticationMode(
    authenticationMode)

Input Parameters

Parameter	Description
authenticationMode	Specifies the authentication mode for which the status is requested. The data type is constant. For the authentication modes, see Authentication Modes.

 

Example

function isAuthUsingTouchSupported() {  
    var status = kony.localAuthentication.getStatusForAuthenticationMode(constants.LOCAL_AUTHENTICATION_MODE_TOUCH_ID);  
    if (status == 5000)    {     
        kony.ui.Alert({
            message: "AUTHENTICATION BY TOUCHID SUPPORTED",
            alertType: constants.ALERT_TYPE_INFO,
            yesLabel: "Close"
        }, {});   
    }  
    else    {     
        var msg = "TOUCHID AUTHENTICATION RETURNED THE STATUS ::" + status;     
        kony.ui.Alert({
            message: status,
            alertType: constants.ALERT_TYPE_INFO,
            yesLabel: "Close"
        }, {});   
    }
}

Return Values

Return Value	Description
status	A status code is returned indicating the support for local authentication using Touch ID or Face ID. For information about how to detect whether a device supports either the Touch ID or Face ID feature, refer the getBiometryType API.

 

Remarks

Using the API, you can verify whether local authentication is supported on the device.

The API also returns different status codes based on the state of the device. For status codes, see the Status Codes section.

Platform Availability

• iOS
• Android

---