Struct LAPolicy

#[repr(transparent)]
pub struct LAPolicy(pub NSInteger);

Available on crate feature LAContext only.

Apple’s documentation

Tuple Fields

0: NSInteger

Implementations

impl LAPolicy

pub const DeviceOwnerAuthenticationWithBiometrics: Self

Device owner will be authenticated using a biometric method (Touch ID).

Biometric authentication is required. If Touch ID is not available, not enrolled or locked out, then the evaluation of this policy will fail with LAErrorBiometryNotAvailable, LAErrorBiometryNotEnrolled or LAErrorBiometryLockout.

Touch ID authentication dialog contains a cancel button with default title “Cancel” which can be customized using localizedCancelTitle property, and a fallback button with default title “Use Password…” which can be customized using localizedFallbackTitle property. Clicking either button causes evaluatePolicy call to fail, returning a distinct error code: LAErrorUserCancel or LAErrorUserFallback.

Biometric authentication will get locked after 5 unsuccessful attempts. After that, users have to unlock it by entering their account password. The password can be entered either at login window or in the preference sheets or even in application by the means of LAPolicyDeviceOwnerAuthentication. The system unlock is preferred user experience because we generaly don’t want users to enter their account password at application’s request.

pub const DeviceOwnerAuthentication: Self

Device owner will 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 LAPolicyDeviceOwnerAuthenticationWithBiometrics. However, the “Use Password..” button does not end the authentication. Instead, it switches the authentication mechanism to user password.

pub const DeviceOwnerAuthenticationWithWatch: Self

👎Deprecated

Device owner will be authenticated by Watch.

Watch authentication is required. If no nearby paired watch device can be found, LAErrorWatchNotAvailable 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.

pub const DeviceOwnerAuthenticationWithCompanion: Self

Device owner will be authenticated by a companion device e.g. Watch, Mac, etc.

Companion authentication is required. If no nearby paired companion device can be found, LAErrorCompanionNotAvailable is returned.

Users should follow instructions on the companion device to authenticate.

pub const DeviceOwnerAuthenticationWithBiometricsOrWatch: Self

👎Deprecated

Device owner will be authenticated by biometry or Watch.

Watch or biometric authentication is required. If no nearby paired watch device can be found, it behaves as LAPolicyDeviceOwnerAuthenticationWithBiometrics. Similarly, if biometry is unavailable it behaves as LAPolicyDeviceOwnerAuthenticationWithWatch.

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.

pub const DeviceOwnerAuthenticationWithBiometricsOrCompanion: Self

Device owner will be authenticated by biometry or a companion device e.g. Watch, Mac, etc.

Companion or biometric authentication is required. If no nearby paired companion device can be found, it behaves as LAPolicyDeviceOwnerAuthenticationWithBiometrics. Similarly, if biometry is unavailable it behaves as LAPolicyDeviceOwnerAuthenticationWithCompanion.

When both mechanisms are available, user is asked to use biometry and companion authentication will run in parallel. Users should follow instructions on the companion device to authenticate.

pub const DeviceOwnerAuthenticationWithWristDetection: Self

Device owner will be authenticated by device passcode. The authentication will also succeed if the wrist detection is enabled, correct passcode was entered in the past and the watch has been on the wrist ever since.

Trait Implementations

impl Clone for LAPolicy

fn clone(&self) -> LAPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LAPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for LAPolicy

const ENCODING: Encoding = NSInteger::ENCODING

The Objective-C type-encoding for this type.

impl Hash for LAPolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LAPolicy

fn cmp(&self, other: &LAPolicy) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LAPolicy

fn eq(&self, other: &LAPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for LAPolicy

fn partial_cmp(&self, other: &LAPolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for LAPolicy

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Copy for LAPolicy

impl Eq for LAPolicy

impl StructuralPartialEq for LAPolicy