MobileAccessState

public enum MobileAccessState

Enum describing global errors or warnings from the SDK

  • This device is not supported.

    Declaration

    Swift

    case errorDeviceNotSupported

  • iOS only - This device requires a passcode to be set before we can use secure credential storage

    Declaration

    Swift

    case errorNoPasscodeSet

  • No credentials are available. This means that no scanning via BLE or NFC will occur i.e. you will not be able to find devices or attempt to access them.

    Declaration

    Swift

    case errorNoCredentials

  • The operating system the software is running on is too old. None of the functionality if the SDK is available.

    Declaration

    Swift

    case errorUnsupportedOsVersion

  • This device does not have Bluetooth hardware.

    Declaration

    Swift

    case errorNoBleFeature

  • Android only - Location services are disabled in the system settings. On Android, BLE functionality requires the location service to operate. NFC functionality may still operate.

    Declaration

    Swift

    case bleErrorLocationServiceDisabled

  • Androind only - App does not have permission to use location services. On Android, BLE functionality requires the ACCESS_FINE_LOCATION permission to be granted. NFC functionality may still operate.

    Declaration

    Swift

    case bleErrorNoLocationPermission

  • iOS only - Location services are disabled in the system settings On iOS, location services is only required for BLE functionality with extended background scanning mode.

    Declaration

    Swift

    case bleWarningExtendedBackgroundScanningRequiresLocationServiceEnabled

  • iOS only - App does not have permission to use location services in the background. On iOS, the BLE extended background scanning mode requires location access ALWAYS permissions.

    Declaration

    Swift

    case bleWarningExtendedBackgroundScanningRequiresLocationAlwaysPermission

  • Bluetooth is currently disabled in the system settings or powered off.

    Declaration

    Swift

    case bleErrorDisabled

  • iOS only - The application is not authorized to use Bluetooth.

    Declaration

    Swift

    case bleErrorUnauthorized

  • Android only - This device has NFC hardware, but NFC is disabled in the system settings. BLE functionality may still operate.

    Declaration

    Swift

    case nfcErrorDisabled

  • Android only - This device does not have NFC hardware. BLE functionality may still operate.

    Declaration

    Swift

    case noNfcFeature

  • iOS Only:

    • A credential was registered using biometrics (Fingerprint/FaceID)
    • Fingerprint/FaceID was later disabled in the system settings
    • Second factor access will not function on that credential until Fingerprint/FaceID are re-enabled in the system settings

    Declaration

    Swift

    case credentialRequiresBiometricsEnrolment
    • A credential was registered using biometrics
    • The biometric function is currently locked out due to failed attempts

    Declaration

    Swift

    case credentialBiometricsLockedOut

  • Android only - The app must be granted the ACCESS_BACKGROUND_LOCATION permission in order for BLE scanning to function in the background. Foreground scanning and NFC functionality may still operate.

    Declaration

    Swift

    case bleErrorNoBackgroundLocationPermission