iOS Trust SDK Native Interface
This page describes all classes that represent the public API interface between mobile developer integrators and the Daon Trust SDK.
TrustSDK
Represents the main entry point to the Daon Trust SDK.
| Method Name | Description |
|---|---|
| TrustSDK(withViewController: self, delegate: self) | Default constructor that requires host view controller and DaonEventDelegate as a Trust SDK event delegate. |
| start(withDaonOptions: options) | Starts the onboarding flow with SDK options object. |
| stop() | This method terminates the current SDK flow, dismisses any active view controller, and notifies the delegate with a failure event (sdkProgrammaticallyStopped). |
| addDocumentProcessor(processor: DaonDocumentProcessorModule) | Add a document processing module to the TrustSDK. This is typically used for MRZ reading and NFC scanning. |
DaonOptions
| Field Name | Description |
|---|---|
| String serverUrl | Server URL that will be used to initialize the Trust SDK. |
| TimeInterval initializationTimeout | The allotted wait time for the Trust SDK to initialize. Default value is 10 seconds (10000L). |
| String qrInstructionLabel | Description label in QR scan screen. If not set, the label will not be shown. |
| String spinnerLabel | Description label under spinner while loading scanned QR. If not set, the label will not be shown. |
| Bool isWebLoadedEnabled | Web loaded is a safety feature of the Trust SDK. onboarding web app that indicates when a valid web page has loaded. By default, this feature is set to true. This feature should be disabled only for development/debug purpose. |
| Bool isWhitelistingEnabled | Whitelisting is a safety feature of the Trust SDK that indicates if the web page is whitelisted. By default, this feature is set to true. This feature should be disabled only for development/debug purpose. |
| Bool isAnalyticsEnabled | The default value is TRUE. Optional parameter that indicates whether event logging is enabled or not. |
| Bool isWebToolbarEnabled | Enable this feature for back/ forward web actions in the navigation bar. This should be enabled only for development/ debugging purposes or if the web app requires web navigation. Defaults to FALSE. |
DaonEventDelegate
| Method Name | Description |
|---|---|
| didReceive(successResponse daonEvent: DaonEvent) | Event that will happened when user finishes the flow. |
| didReceive(failedResponse daonEvent: DaonEvent) | Termination event - This will be triggered if a critical event occurs and the user is unable continue the flow. Additional data will be provided through the event object. |
| didReceive(infoResponse daonEvent: DaonEvent) | Runtime event that will inform integrator on current SDK progress. Additional data will be provided though event object. |
DaonEvent
| Field Name | Description |
|---|---|
| DaonEventCode code | Field that contains event code. |
| description | Field that contains description/reason of the event. |
Builder
The Builder class allows users to construct an instance of DocumentProcessor with specific settings
| Method Name | Description |
|---|---|
| setLicense(license: String) | Used to set the license string that is mandatory in order for Trust SDK OCR and NFC features to work. |
| setErrorDialogMessage(message: String) | If a custom or default error message is desired, it can be set using this method. Otherwise, if left unset, the SDK will return an error message obtained from the error.localizedDescription property. |
| build() | Builds the final DocumentProcessor instance which you can use to scan your document. |