Package apple.visionkit.protocol

Interface VNDocumentCameraViewControllerDelegate

public interface VNDocumentCameraViewControllerDelegate

A delegate protocol through which the document camera returns its scanned results. Your app is responsible for dismissing the document camera in all delegate callback methods. API-Since: 13.0

Method Summary

Modifier and Type	Method	Description
default void	documentCameraViewControllerDidCancel(@NotNull VNDocumentCameraViewController controller)	Tells the delegate that the user canceled out of the document scanner camera.
default void	documentCameraViewControllerDidFailWithError(@NotNull VNDocumentCameraViewController controller, @NotNull NSError error)	Tells the delegate that document scanning failed while the camera view controller was active.
default void	documentCameraViewControllerDidFinishWithScan(@NotNull VNDocumentCameraViewController controller, @NotNull VNDocumentCameraScan scan)	Tells the delegate that the user successfully saved a scanned document from the document camera.

Method Detail

documentCameraViewControllerDidFailWithError

default void documentCameraViewControllerDidFailWithError(@NotNull
                                                          @NotNull VNDocumentCameraViewController controller,
                                                          @NotNull
                                                          @NotNull NSError error)

Tells the delegate that document scanning failed while the camera view controller was active. - Parameter controller: The document camera view controller that failed. - Parameter error: The error containing the reason for failure.

documentCameraViewControllerDidFinishWithScan

default void documentCameraViewControllerDidFinishWithScan(@NotNull
                                                           @NotNull VNDocumentCameraViewController controller,
                                                           @NotNull
                                                           @NotNull VNDocumentCameraScan scan)

Tells the delegate that the user successfully saved a scanned document from the document camera. - Parameter controller: The document camera view controller that captured the scan. - Parameter scan: The scanned document that the camera detected.

documentCameraViewControllerDidCancel

default void documentCameraViewControllerDidCancel(@NotNull
                                                   @NotNull VNDocumentCameraViewController controller)

Tells the delegate that the user canceled out of the document scanner camera. - Parameter controller: The document camera view controller in which the user canceled.