Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Generic Error handling

Launching the SDK always returns a result. The result can be negative and contain an error.

The iOS SDK has generic errors that provide feedback to the integrator about why the process was stopped.

Common - Basic

General states that do not fit into a specific functional category.

  • .NO_ERROR: Default state; indicates that the operation completed without issues.

  • .UNKNOWN_ERROR: An error occurred that has not been identified or specifically categorized.

  • .OTHER(String): Generic error for unhandled cases. Includes a custom message via a String.

Common - Requirements

Errors related to data availability, process lifecycle, or connectivity.

  • .NO_DATA_ERROR: The process needs a configuration value that has not been provided correctly or is null.

  • .OPERATION_NOT_CREATED: The operation could not be initialized correctly.

  • .NETWORK_CONNECTION: Communication error; the device has no internet access or the server is not responding.

Common - Permissions

Triggered when the user or the operating system denies access to hardware or files.

  • CAMERA_PERMISSION_DENIED: Access to the device camera was blocked.

  • MIC_PERMISSION_DENIED: Access to the microphone was blocked.

  • LOCATION_PERMISSION_DENIED: Location services (GPS) are not authorized.

  • STORAGE_PERMISSION_DENIED: Read/write permission for local storage was denied.

Common - User Interaction

Errors resulting from user behavior or session restrictions.

  • CANCEL_BY_USER: The process was explicitly canceled by the user.

  • SDK_TIMEOUT: The capture process exceeded the maximum wait time configured at the SDK level. The Selphi and SelphID components can also return .SELPHI_TIMEOUT or .SELPHID_TIMEOUT with additional information; serialized as SPI_TIMEOUT or SPD_TIMEOUT through toString(addComponentPrefix:).

Common - License Errors

Validation errors related to the license key or the SDK components.

  • .LICENSE_CHECKER_ERROR(String): General error during license validation with the server. The parameter String indicates the detail more explicitly.

  • .MISSING_COMPONENT_LICENSE_DATA: The component being launched needs data that has not been correctly configured in the license.

  • .COMPONENT_LICENSE_ERROR: The component you are trying to use is not enabled in the license.

  • .EMPTY_LICENSE: The license field is empty.

In addition to the generic ones, each module may contain specific errors that will be detailed on their respective documentation pages.

Last updated