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.