Skip to content

VDDocumentCapture

Class that contains the main functions of the Framework.

Its the main class of this Framework. The public methods of this class are the ones used to make this Framework work.

Public Methods

+ (NSArray*) getConfigurationKeys

This method is used to ask for the SDK’s configuration keys.

  • Returns:

    • An array which contains the SDK configuration keys.
+ (NSDictionary<VDCountry*, NSArray<VDDocument*>*>*) getDocumentsForCountryAvailable

This method is used to ask the SDK for all the possible documents and receives a NSDictionary with them.

  • Returns:

    • Dictionary with all the possible documents for country available.
+ (NSString* _Nonnull) getVersion

This method is used to ask for the SDK’s version.

  • Returns:

    • A string which contains the SDK version.
+ (BOOL) isStarted

This method is used to ask the SDK if it is already running.

  • Returns:

    • Whether the SDK is running or not
+ (UIViewController*) startWithDelegate: (UIViewController<VDDocumentCaptureProtocol>*) delegate andDocumentIds: (NSArray<NSString*>*) documents

This method is needed to use the SDK. It programs the delegate to which the SDK will notify the outputs and sets the documents used by the SDK. If the documents provided is nil or not valid, all the available documents will be used.

  • Parameters:

    • delegate: The instance to which the SDK will notify all its outputs.
    • documents: An array with the document ids to search in the framework.
  • Returns:

    • The UIViewController that is shown.
+ (UIViewController*) startWithDelegate: (UIViewController<VDDocumentCaptureProtocol>*) delegate andDocumentIds:(NSArray<NSString*>*) documents andConfiguration: (NSDictionary*) config

This method is needed to use the SDK. It programs the delegate to which the SDK will notify the outputs and sets the documents used by the SDK. If the documents provided is nil or not valid, all the available documents will be used.

  • Parameters:

    • delegate: The instance to which the SDK will notify all its outputs.
    • documents: An array with the document ids to search in the framework.
    • config: The configuration of the SDK.
  • Returns:

    • The UIViewController that is shown.
+ (UIViewController*) startWithDelegate: (UIViewController<VDDocumentCaptureProtocol>*) delegate andDocuments:(NSArray<VDDocument*>*) documents

DEPRECATED. This method is needed to use the SDK. It programs the delegate to which the SDK will notify the outputs and sets the documents used by the SDK. If the documents provided is nil or not valid, all the available documents will be used.

  • Parameters:

    • delegate: The instance to which the SDK will notify all its outputs.
    • documents: An array with the documents to search in the framework.
  • Returns:

    • The UIViewController that is shown.
+ (UIViewController*) startWithDelegate: (UIViewController<VDDocumentCaptureProtocol>*) delegate andDocuments:(NSArray<VDDocument*>*) documents andConfiguration:(NSDictionary*) config

DEPRECATED. This method is needed to use the SDK. It programs the delegate to which the SDK will notify the outputs and sets the documents used by the SDK. If the documents provided is nil or not valid, all the available documents will be used.

  • Parameters:

    • delegate: The instance to which the SDK will notify all its outputs.
    • documents: An array with the documents to search in the framework.
    • config: The configuration of the SDK.
  • Returns

    • The UIViewController that is shown.
+ (void) stop

This method will stop the SDK and all its functionalities, so it needs to be started again. The SDK will not provide any more outputs after this method and the app flow will be given to the app.