Variable SensibillCaptureStandaloneConst

Type declaration

• captureDocuments: ((config?: SbCaptureConfiguration) => Promise<string[]>)

  • • (config?: SbCaptureConfiguration): Promise<string[]>

    • Run this method to launch the standalone capture flow. The method returns a Promise conveying the result of the capture flow.

      The resolution of the returned promise can mean the following things:

      • Rejected: -> (Android only) The capture flow failed to launch altogether, the user never entered the capture flow. -> Capture completed, however there was a filesystem error and the output files couldn't be created.
      • Resolved - Null or Empty: -> The capture flow launched, but there were no resulting images. The user cancelled the flow.
      • Resolved - Populated List: -> Image(s) were captured, and their filepaths are returned.

      Suggested next actions:

      • Rejected: -> Some system error likely occurred, trying again immediately is not likely to provide a different result. Display an error and don't immediately try again.
      • Resolved - Null or Empty: -> The user cancelled the flow manually, likely you'd want to do nothing here.
      • Resolved - Populated List: -> Now that you've received images, you can process or display them however you wish. Please remember to delete the image files once you're done with them

      Throws

      Returns

      The promise resolving to the filepaths of the captured images if capture was successful

      Parameters

      • Optional config: SbCaptureConfiguration

        The CaptureConfiguration to run the capture flow with

      Returns Promise<string[]>