@thegrizzlylabs/react-native-genius-scan 6.1.0 → 6.3.0

package/ios/GSSDK/GSSDK.xcframework/ios-arm64_x86_64-simulator/GSSDK.framework/Headers/GSSDK-Swift.h

@@ -765,7 +765,7 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerFailedToFindDocument:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller real-time document detection will soon take the photo of a quadrangle, but if the document
+/// The camera view controller real-time document detection will soon capture a detected document, but if the document
 /// detection is not stable enough, the process can still be
 /// cancelled.
 /// It’s a good time to tell the user to remain stable.
@@ -773,18 +773,36 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerPhotoStabilizationDidStart:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller is about to decide whether to automatically take a photo because the detection was stable enough.
+/// The camera view controller is about to decide whether to automatically capture a detected document because the detection was stable enough.
 /// This is an override point where you can return <code>false</code> to stop that automatic process from proceeding.
 /// \param cameraViewController The camera view controller
 ///
 - (BOOL)cameraViewControllerShouldSnapPhoto:(GSKCameraViewController * _Nonnull)cameraViewController SWIFT_WARN_UNUSED_RESULT;
-/// The camera view controller is going to automatically take a photo because the detection was stable enough.
-/// The photo taking is underway and cannot be interrupted at this stage.
+/// The camera view controller is going to capture a photo, whether the capture was triggered manually or automatically.
+/// When the capture is automatic, this is called after <code>cameraViewController:willAutoCaptureDocumentWithQuadrangle:</code>.
 /// \param cameraViewController The camera view controller
 ///
-/// \param quadrangle The quadrangle of the document that will be photographed.
+- (void)cameraViewControllerWillCapturePhoto:(GSKCameraViewController * _Nonnull)cameraViewController;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// <ul>
+///   <li>
+///     Deprecated: Use <code>cameraViewController(_:willAutoCaptureDocumentWithQuadrangle:)</code> for automatic document captures
+///     or <code>cameraViewControllerWillCapturePhoto(_:)</code> for any capture.
+///   </li>
+/// </ul>
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
 ///
 - (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willSnapPhotoWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
+///
+- (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willAutoCaptureDocumentWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
 /// The camera view controller just took a photo, but it hasn’t been post-processed it yet
 /// \param cameraViewController The camera view controller
 ///
@@ -1224,7 +1242,8 @@ SWIFT_CLASS("_TtC5GSSDK14GSKPDFDocument")
 @property (nonatomic, readonly, copy) NSString * _Nullable title;
 /// If provided, this password will be used to protect the PDF document.
 /// It will need to be entered to view or edit the document.
-/// RC4 encryption algorithm is used with a 128-bit key.
+/// AES-256 encryption is used.
+/// An empty password is treated as no password.
 @property (nonatomic, readonly, copy) NSString * _Nullable password;
 /// If provided, the keywords will be included in the PDF document properties
 @property (nonatomic, readonly, copy) NSString * _Nullable keywords;
@@ -1349,6 +1368,11 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// will only scan a single page. The output document will always contain
 /// a single page. Defaults to <code>true</code>.
 @property (nonatomic) BOOL multiPage;
+/// Whether the user should be presented with a screen that lets them review all
+/// captured scans at the end of the scan flow, where they’ll be able to edit each
+/// scan once more before finally submitting the captured scans for processing.
+/// Defaults to <code>false</code>.
+@property (nonatomic) BOOL showFinalReview;
 /// What orientation that a scan should be rotated to after it’s been captured.
 /// Defaults to <code>automatic</code>. See <code>GSKScanOrientation</code> for more information.
 @property (nonatomic) enum GSKScanOrientation defaultScanOrientation;
@@ -1372,10 +1396,14 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// Whether the photo library button should be hidden during camera-based scan flows. Defaults to <code>false</code>.
 @property (nonatomic) BOOL photoLibraryButtonHidden;
 /// Determines the default flash mode. Combine this with <code>flashButtonHidden</code>
-/// if you want to only allow a specific flash mode. Defaults to <code>.auto</code>.
+/// if you want to only allow a specific flash mode. Defaults to <code>.off</code>.
 @property (nonatomic) enum GSKScanFlowFlashMode defaultFlashMode;
 /// Determines the document format. Defaults to <code>.PDF</code>.
 @property (nonatomic) enum GSKScanFlowMultiPageFormat multiPageFormat;
+/// Optional password used to protect generated PDF documents.
+/// An empty password is treated as no password.
+/// This only applies when <code>multiPageFormat</code> is <code>.pdf</code>.
+@property (nonatomic, copy) NSString * _Nullable pdfPassword;
 /// Custom font file used during PDF generation to embed an invisible text
 /// layer. If <code>nil</code>, a default font is used, which only supports Latin languages.
 @property (nonatomic, copy) NSURL * _Nullable pdfFontFileURL;
@@ -2562,7 +2590,7 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerFailedToFindDocument:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller real-time document detection will soon take the photo of a quadrangle, but if the document
+/// The camera view controller real-time document detection will soon capture a detected document, but if the document
 /// detection is not stable enough, the process can still be
 /// cancelled.
 /// It’s a good time to tell the user to remain stable.
@@ -2570,18 +2598,36 @@ SWIFT_PROTOCOL("_TtP5GSSDK31GSKCameraViewControllerDelegate_")
 /// \param cameraViewController The camera view controller
 ///
 - (void)cameraViewControllerPhotoStabilizationDidStart:(GSKCameraViewController * _Nonnull)cameraViewController;
-/// The camera view controller is about to decide whether to automatically take a photo because the detection was stable enough.
+/// The camera view controller is about to decide whether to automatically capture a detected document because the detection was stable enough.
 /// This is an override point where you can return <code>false</code> to stop that automatic process from proceeding.
 /// \param cameraViewController The camera view controller
 ///
 - (BOOL)cameraViewControllerShouldSnapPhoto:(GSKCameraViewController * _Nonnull)cameraViewController SWIFT_WARN_UNUSED_RESULT;
-/// The camera view controller is going to automatically take a photo because the detection was stable enough.
-/// The photo taking is underway and cannot be interrupted at this stage.
+/// The camera view controller is going to capture a photo, whether the capture was triggered manually or automatically.
+/// When the capture is automatic, this is called after <code>cameraViewController:willAutoCaptureDocumentWithQuadrangle:</code>.
 /// \param cameraViewController The camera view controller
 ///
-/// \param quadrangle The quadrangle of the document that will be photographed.
+- (void)cameraViewControllerWillCapturePhoto:(GSKCameraViewController * _Nonnull)cameraViewController;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// <ul>
+///   <li>
+///     Deprecated: Use <code>cameraViewController(_:willAutoCaptureDocumentWithQuadrangle:)</code> for automatic document captures
+///     or <code>cameraViewControllerWillCapturePhoto(_:)</code> for any capture.
+///   </li>
+/// </ul>
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
 ///
 - (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willSnapPhotoWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
+/// The camera view controller is going to automatically capture a detected document because the detection was stable enough.
+/// The automatic capture is about to start and cannot be interrupted at this stage.
+/// \param cameraViewController The camera view controller
+///
+/// \param quadrangle The quadrangle of the document that will be captured.
+///
+- (void)cameraViewController:(GSKCameraViewController * _Nonnull)cameraViewController willAutoCaptureDocumentWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
 /// The camera view controller just took a photo, but it hasn’t been post-processed it yet
 /// \param cameraViewController The camera view controller
 ///
@@ -3021,7 +3067,8 @@ SWIFT_CLASS("_TtC5GSSDK14GSKPDFDocument")
 @property (nonatomic, readonly, copy) NSString * _Nullable title;
 /// If provided, this password will be used to protect the PDF document.
 /// It will need to be entered to view or edit the document.
-/// RC4 encryption algorithm is used with a 128-bit key.
+/// AES-256 encryption is used.
+/// An empty password is treated as no password.
 @property (nonatomic, readonly, copy) NSString * _Nullable password;
 /// If provided, the keywords will be included in the PDF document properties
 @property (nonatomic, readonly, copy) NSString * _Nullable keywords;
@@ -3146,6 +3193,11 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// will only scan a single page. The output document will always contain
 /// a single page. Defaults to <code>true</code>.
 @property (nonatomic) BOOL multiPage;
+/// Whether the user should be presented with a screen that lets them review all
+/// captured scans at the end of the scan flow, where they’ll be able to edit each
+/// scan once more before finally submitting the captured scans for processing.
+/// Defaults to <code>false</code>.
+@property (nonatomic) BOOL showFinalReview;
 /// What orientation that a scan should be rotated to after it’s been captured.
 /// Defaults to <code>automatic</code>. See <code>GSKScanOrientation</code> for more information.
 @property (nonatomic) enum GSKScanOrientation defaultScanOrientation;
@@ -3169,10 +3221,14 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 /// Whether the photo library button should be hidden during camera-based scan flows. Defaults to <code>false</code>.
 @property (nonatomic) BOOL photoLibraryButtonHidden;
 /// Determines the default flash mode. Combine this with <code>flashButtonHidden</code>
-/// if you want to only allow a specific flash mode. Defaults to <code>.auto</code>.
+/// if you want to only allow a specific flash mode. Defaults to <code>.off</code>.
 @property (nonatomic) enum GSKScanFlowFlashMode defaultFlashMode;
 /// Determines the document format. Defaults to <code>.PDF</code>.
 @property (nonatomic) enum GSKScanFlowMultiPageFormat multiPageFormat;
+/// Optional password used to protect generated PDF documents.
+/// An empty password is treated as no password.
+/// This only applies when <code>multiPageFormat</code> is <code>.pdf</code>.
+@property (nonatomic, copy) NSString * _Nullable pdfPassword;
 /// Custom font file used during PDF generation to embed an invisible text
 /// layer. If <code>nil</code>, a default font is used, which only supports Latin languages.
 @property (nonatomic, copy) NSURL * _Nullable pdfFontFileURL;