ScanbotSDKUI

@interface ScanbotSDKUI : NSObject

Helper class to configure properties of the ScanbotSDKUI (SBSDKUI) components.

  • Sets the SBSDKUI-component-wide encrypter for storing image data to disk. Defaults to nil. If set to nil no encryption is used at all. You can use the built-in encrypter SBSDKAESEncrypter to encrypt your sensitive image data using AES128 or AES256 before storing it to disk.

    When using encryption you still can access the unencrypted images in the image storage. Of course, encrypted storages cannot be read without the proper encrypter being set here. You are responsible for migrating image storages.

    Important: If you wish to use the SBSDKUI-wide encryption setup your encrypter before using any of the SBSDKUI-API. A good place to configure it, is your AppDelegates entry point, right where the license is set. Once SBSDKUI-API is used the storages are created and any change to the default encrypter is of no effect.

    For standard components, prefixed with SBSDK (without UI) the default encrypter has no effect, since there is no image storage by default. You can, of course, create instances of SBSDKKeyedImageStorage and SBSDKIndexedImageStorage and initialize them with an encrypter of your choice.

    Declaration

    Objective-C

    + (void)setDefaultImageStoreEncrypter:
        (nullable id<SBSDKStorageCrypting>)encrypter;

    Swift

    class func setDefaultImageStoreEncrypter(_ encrypter: SBSDKStorageCrypting?)
  • The encrypter used in all SBSDKUI components for encrypting images before storing to disk.

    Declaration

    Objective-C

    + (nullable id<SBSDKStorageCrypting>)defaultImageStoreEncrypter;

    Swift

    class func defaultImageStoreEncrypter() -> SBSDKStorageCrypting?

    Return Value

    The default image storage encrypter if set, nil otherwise.

  • Sets the SBSDKUI-component-wide encrypter for storing PDF files to disk. Defaults to nil. If set to nil no encryption is used at all. You can use the built-in encrypter SBSDKAESEncrypter to encrypt your sensitive pdf files using AES128 or AES256 before storing it to disk.

    Important: If you wish to use the SBSDKUI-wide encryption setup your encrypter before using any of the SBSDKUI-API. A good place to configure it, is your AppDelegates entry point, right where the license is set.

    For standard components, prefixed with SBSDK (without UI) the default pdf encrypter has no effect. Here you have to set it up for the PDF renderer individually.

    Declaration

    Objective-C

    + (void)setDefaultPDFEncrypter:(nullable id<SBSDKStorageCrypting>)encrypter;

    Swift

    class func setDefaultPDFEncrypter(_ encrypter: SBSDKStorageCrypting?)
  • The encrypter used in all SBSDKUI components for encrypting generated PDF files before storing to disk.

    Declaration

    Objective-C

    + (nullable id<SBSDKStorageCrypting>)defaultPDFEncrypter;

    Swift

    class func defaultPDFEncrypter() -> SBSDKStorageCrypting?

    Return Value

    The default pdf encrypter if set, nil otherwise.

  • Scanning viewcontrollers in SBSDKUI components can show or hide the status bar. This is the default value for all scanning viewcontrollers upon their initialization.

    The default value is NO.

    Declaration

    Objective-C

    + (BOOL)shouldShowStatusBarOnScanningScreens;

    Swift

    class func shouldShowStatusBarOnScanningScreens() -> Bool

    Return Value

    YES, if the status bar in scanning viewcontrollers is shown by default, NO otherwise.

  • Scanning viewcontrollers in SBSDKUI components can show or hide the status bar. This sets the default value for all scanning viewcontrollers upon their initialization.

    You still can individually set the status bar visibility for each instance of any scanning viewcontroller using its shouldShowStatusBar property.

    Declaration

    Objective-C

    + (void)setShouldShowStatusBarOnScanningScreens:(BOOL)shouldShow;

    Swift

    class func setShouldShowStatusBarOnScanningScreens(_ shouldShow: Bool)

    Parameters

    shouldShow

    Set to YES, if the status bar in scanning viewcontrollers should be shown by default, NO otherwise. The default value is NO.

  • The default status bar style of all SBSDKUI components upon their initialization. Defaults to UIStatusBarStyleLightContent.

    Declaration

    Objective-C

    + (UIStatusBarStyle)defaultStatusBarStyle;

    Swift

    class func defaultStatusBarStyle() -> UIStatusBarStyle

    Return Value

    The default status bar style of all SBSDKUI components.

  • Sets the default status bar style of all SBSDKUI components.

    You still can individually set the status bar style for each instance of any SBSDKUI viewcontroller using its statusBarStyle property.

    Declaration

    Objective-C

    + (void)setDefaultStatusBarStyle:(UIStatusBarStyle)style;

    Swift

    class func setDefaultStatusBarStyle(_ style: UIStatusBarStyle)

    Parameters

    style

    The default status bar style of all SBSDKUI components.