CheckUserIdentity (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Specific Mobile functions

Phone management functions

CheckUserIdentity

Presentation

Example

Application in the background: Specific case from Android 10

See also

Phone management functions

CheckUserIdentity (Function)

In french: VérifieIdentitéUtilisateur

Allows you to check the real identity of the current user via biometrics check.

If the authentication is available, a message asks the user to authenticate himself. Then, the WLanguage authentication procedure is called.

Caution: This function only verifies the user's identity via the data stored on the mobile phone. It is not possible to capture the user's fingerprint.

Remarks:

This function is available from iOS version 8.0. The project must be compiled with Xcode 6 (or later). This function is using:
- the "Touch ID" feature of iPhones 5S and later versions.
- Versions 23 and later
  the "Facial recognition" feature of iPhone X.
  New in version 23
  the "Facial recognition" feature of iPhone X.
  the "Facial recognition" feature of iPhone X.
Versions 23 and later
This feature is available from Android 6.0 (api level 23).
New in version 23
This feature is available from Android 6.0 (api level 23).
This feature is available from Android 6.0 (api level 23).

Versions 23 and later

This function is now available for Android applications.

New in version 23

This function is now available for Android applications.

Example

CheckUserIdentity("Check the identity for unlocking", Authentication)

// Check procedure
PROCEDURE Authentication(nStatus is int, sErrorMessage is string)

SWITCH nStatus
CASE cuiAuthenticated
Info("Authentication OK")
CASE cuiAuthenticationFailure
Error("Authentication failure: " + sErrorMessage)
CASE cuiAuthenticationUnavailable
Error("Authentication not available")
CASE cuiCustomAuthentication
pwd is string
// Comments typed by the user in a multiline control
SWITCH Input("Enter the password: ", pwd)
// OK
CASE 1:
// Cancel
CASE 0:
END
END

Syntax

CheckUserIdentity(<Message> , <WLanguage procedure> [, <Button caption>])

<Message>: Character string

Message that will be displayed to the user.

If this string is a multiline string, only the first line will be visible in the authentication popup.
This parameter is ignored during a facial recognition.

<WLanguage procedure>: Procedure name

Name of the WLanguage procedure ("callback") called once the user authentication is complete. This procedure has the following format:

PROCEDURE <Procedure name> (<Status>, <Error message>)

where:
is an Integer constant indicating the authentication status:
cuiAuthenticated The user was properly authenticated.
cuiAuthenticationFailure The authentication failed.
cuiAuthenticationUnavailable The authentication feature is not available or it was disabled by the user.
cuiCustomAuthentication The user wants to authenticate by using a password: the application will have to manage this authentication manually
is a character string containing the system error message if the authentication fails (cuiAuthenticationFailure constant). Otherwise, this parameter corresponds to an empty string.

<Button caption>: Optional character string

Default caption of authentication button (displayed on the button for typing the password). This button is used to connect without checking the biometrics. This button is displayed as soon as the first failure occurs.

Remarks

Versions 25 and later

Application in the background: Specific case from Android 10

From Android 10, it is no longer possible to open a window when the application is in the background.

CheckUserIdentity can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). The application will be brought back to the foreground when the notification is clicked, if the ActivateApplication property is set to True. You can also open a window from the procedure passed to the ActionClick property.

For more details, see Android 10: Behavior of applications in the background.

New in version 25

Application in the background: Specific case from Android 10

From Android 10, it is no longer possible to open a window when the application is in the background.

CheckUserIdentity can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). The application will be brought back to the foreground when the notification is clicked, if the ActivateApplication property is set to True. You can also open a window from the procedure passed to the ActionClick property.

For more details, see Android 10: Behavior of applications in the background.

Application in the background: Specific case from Android 10

From Android 10, it is no longer possible to open a window when the application is in the background.

CheckUserIdentity can open a window. If this function is used while the application is in the background, a fatal error will occur.

Tips:

It is possible to determine if the application is in the background using InBackgroundMode.
If an application needs to interact with the user while it is in the background, the solution is to display a notification (via the Notification type). The application will be brought back to the foreground when the notification is clicked, if the ActivateApplication property is set to True. You can also open a window from the procedure passed to the ActionClick property.

For more details, see Android 10: Behavior of applications in the background.

Component: wd270android.aar