ResourcesInitializer Class Reference

#import <ResourcesInitializer.h>

Inheritance diagram for ResourcesInitializer:

Class Methods
(BOOL)	+ initBaseWithError:
(BOOL)	+ initSdcWithError:
(BOOL)	+ initSdsWithError:

Detailed Description

ResourcesInitializer provides the means to initialize the resources required by sensitivity.io

Method Documentation

initBaseWithError:()

+ (BOOL) initBaseWithError:

(NSError *_Nullable *_Nullable)

error

Initializes sensitivity.io base resources

Attention

Must be called once on app lifetime before performing any other sensitivity.io library resource initialization.

Note

This Objective C method to initialize the base resources is equivalent to the following:

#import <cppdevtk/base/init_resources.hpp>
#import <cppdevtk/util/init_resources.hpp>
#import <sensitivityio/c_base/init_resources.h>

cppdevtk_base_init_resources();
cppdevtk_util_init_resources();
sensitivityio_base_init_resources();

In case you already use cppdevtk library in your application, include only the missing init resources from the list above, instead of using initBaseWithError.

Parameters

error

The error representing the reason for the failure

Returns

True on success, false in case an error occured

initSdcWithError:()

+ (BOOL) initSdcWithError:

(NSError *_Nullable *_Nullable)

error

Initializes sensitivity.io sensitive data classification(SDC) resources

Attention

Must be called once on app lifetime before performing any classification, otherwise the classification will fail

Precondition

Initialize sensitivity.io base resources first

Parameters

error

The error representing the reason for the failure

Returns

True on success, false in case an error occured

Provided by category ResourcesInitializer(SDC).

initSdsWithError:()

+ (BOOL) initSdsWithError:

(NSError *_Nullable *_Nullable)

error

Initializes sensitivity.io sensitive data scanner(SDS) resources

Attention

Must be called once on app lifetime before performing any scan, otherwise the scan will fail

Note

This Objective C method to initialize the SDS resources is equivalent to the following:

#import <sensitivityio/file_magic/init_resources.hpp>
#import <sensitivityio/c_sds/init_resources.h>

sensitivityio_file_magic_init_resources();
sensitivityio_sds_init_resources();

In case you already use file_magic library in your application, include only the missing init resources from the list above, instead of using initSdsWithError.

Precondition

Initialize sensitivity.io base resources first

Parameters

error

The error representing the reason for the failure

Returns

True on success, false in case an error occured

Provided by category ResourcesInitializer(SDS).

---

The documentation for this class was generated from the following file:

• ResourcesInitializer.h