Kofax Mobile SDK API Reference
Instance Methods | List of all members
<kfxIDCaptureViewControllerDelegate> Protocol Reference

This protocol defines methods that your delegate object should implement to interact with kfxIDCaptureViewController. More...

#import <kfxIDCaptureViewController.h>

Inheritance diagram for <kfxIDCaptureViewControllerDelegate>:
<kfxCaptureViewControllerDelegate>

Instance Methods

(void) - idCaptureViewController:didExtractID:error:
 Tells the delegate that the ID capture is finished and result data is available. More...
 
- Instance Methods inherited from <kfxCaptureViewControllerDelegate>
(void) - captureViewControllerDidClose:
 Tells the delegate that the user is going to close capture view controller. More...
 

Detailed Description

This protocol defines methods that your delegate object should implement to interact with kfxIDCaptureViewController.

The methods of this protocol notify your delegate with various messages related to ID capture.

See also
kfxCaptureViewControllerDelegate

Method Documentation

- (void) idCaptureViewController: (kfxIDCaptureViewController *)  idCaptureViewController
didExtractID: (kfxIDData *)  idData
error: (NSError *)  error 
optional

Tells the delegate that the ID capture is finished and result data is available.

The methods gets called once when ID capture has finished and provides the ID data depending on the specified parameters. Your delegate's implementation of this method should dismiss the ID capture view controller.

Implementation of this method is optional, but expected.

ID original image should be saved before the other side capture, otherwise it will be deleted from the image storage.

Parameters
idCaptureViewControllerThe ID capture view controller dispatching the message.
idDataThe result ID data. Could be a nil if error is occured.
errorAn NSError object that describes the problem if an internal error occurs. In the case of a server extraction failure, the error's userInfo property will contain a "kfxInternalServerErrorInfo" field with the response from the server.
See also
kfxIDData

The documentation for this protocol was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.