|class||TouchBar||MBS Mac64bit Plugin||17.0||✅ Yes||❌ No||❌ No||✅ Yes||All|
- event evaluatePolicyResult(Success as Boolean, error as NSErrorMBS, Policy as Integer, localizedReason as String, tag as Variant)
- 8 properties
- property biometryType as Integer
- property evaluatedPolicyDomainState as MemoryBlock
- property Handle as Integer
- property interactionNotAllowed as Boolean
- property localizedCancelTitle as String
- property localizedFallbackTitle as String
- property localizedReason as String
- property touchIDAuthenticationAllowableReuseDuration as Double
- 6 methods
- method canEvaluatePolicy(Policy as Integer, byref Error as NSErrorMBS) as Boolean
- method Constructor
- method evaluatePolicy(Policy as Integer, localizedReason as String, Tag as Variant = nil)
- method invalidate
- method isCredentialSet(CredentialType as Integer) as Boolean
- method setCredential(credential as MemoryBlock, Type as Integer) as Boolean
- 2 shared methods
- shared method Available as Boolean
- shared method TouchIDAuthenticationMaximumAllowableReuseDuration as Double
- 23 constants
- const kLAErrorDomain = "com.apple.LocalAuthentication"
The device supports Face ID.
The device does not support biometry.
The device supports Touch ID.
The credential type for an application password.
Smart card PIN provided by application.
If not set, LocalAuthentication will ask users for the smart card PIN when necessary. Applications can provide the PIN using setCredential method. In such case, LocalAuthentication will not show the smart card PIN user interface.
When entered from the LocalAuthentication user interface, the PIN is stored as UTF-8 encoded string.
Authentication was canceled by application (e.g. invalidate was called while authentication was in progress).
Authentication was not successful, because user failed to provide valid credentials.
Authentication was not successful, because there were too many failed Biometry attempts and Biometry is now locked. Passcode is required to unlock Biometry, e.g. evaluating PolicyDeviceOwnerAuthenticationWithBiometrics will ask for passcode as a prerequisite.
Authentication could not start, because Biometry is not available on the device.
Authentication could not start, because Biometry has no enrolled fingers.
LAContext passed to this call has been previously invalidated.
Authentication could not start, because passcode is not set on the device.
Authentication was canceled by system (e.g. another application went to foreground).
Authentication was not successful, because there were too many failed Touch ID attempts and Touch ID is now locked. Passcode is required to unlock Touch ID, e.g. evaluating PolicyDeviceOwnerAuthenticationWithBiometrics will ask for passcode as a prerequisite.
Authentication could not start, because Touch ID is not available on the device.
Authentication could not start, because Touch ID has no enrolled fingers.
Authentication was canceled by user (e.g. tapped Cancel button).
Authentication was canceled, because the user tapped the fallback button (Enter Password).
Device owner is going to be authenticated by biometry or user password.
Touch ID or user password authentication is required. If Touch ID is not available, not enrolled or locked out, then the user is asked for password right away.
Touch ID authentication dialog behaves similarly as the one used by PolicyDeviceOwnerAuthenticationWithBiometrics. However, the "Use Password.." button does not end the authentication. Instead, it switches the authentication mechanism to user password.
The policy for owner authentication with biometrics.
Device owner is going to be authenticated by biometry or Watch.
Watch or biometric authentication is required. If no nearby paired watch device can be found, it behaves as PolicyDeviceOwnerAuthenticationWithBiometrics. Similarly, if biometry is unavailable it behaves as PolicyDeviceOwnerAuthenticationWithWatch.
Watch authentication dialog looks and behaves similarly to biometric variant. When both mechanisms are available, user is asked to use biometry and watch authentication will run in parallel.
Watch authentication is required. If no nearby paired watch device can be found,
kErrorWatchNotAvailable is returned.
Watch authentication dialog looks and behaves similarly to the biometric variant. Users can confirm authentication by double-clicking the side button on their watch.
This class has no sub classes.
Some examples using this class:
- Xojo 2021r1
- MBS Xojo Plugins, version 18.4pr3
- MonkeyBread Software Releases the MBS Xojo plug-ins in version 17.0
- MBS Xojo / Real Studio Plugins, version 17.0pr1
Xojo Developer Magazine
- 15.5, page 9: News
- 15.2, page 35: Inside Xojo, Exploring Delegates, WebFile, and WebPicture by Christian Schmitz
The items on this page are in the following plugins: MBS Mac64bit Plugin.
Feedback: Report problem or ask question.