sensitivity.io for iOS & macOS  1.1.4
Instance Methods | List of all members
ClassificationFuture Class Reference

#import <ClassificationFuture.h>

Inheritance diagram for ClassificationFuture:

Instance Methods

(BOOL) - isResultReady:withError:
 
(Classification *_Nullable) - resultWithError:
 

Detailed Description

ClassificationFuture class provides the means to manipulate and check the status of the classify action it represents and to retrieve the classification found on classify.

Method Documentation

◆ isResultReady:withError:()

- (BOOL) isResultReady: (BOOL *_Nonnull)  resultReady
withError: (NSError *_Nullable *_Nullable)  error 

Checks if the result of classify is ready.

Parameters
resultReadyWill be set to true if the result of classify is ready, false otherwise
errorThe error representing the reason for the failure
Returns
True on success, false in case an error occured

◆ resultWithError:()

- (Classification* _Nullable) resultWithError: (NSError *_Nullable *_Nullable)  error

Returns the result in the future. If the result is not immediately available, this function will block and wait for the result to become available.

Remarks
Relevant errors: SENSITIVITYIO_EINVALIDLICENSE, SENSITIVITYIO_ELICENSEEXPIRED, SENSITIVITYIO_ESETTINGS, SENSITIVITYIO_EUNSUPPORTEDMIMETYPE, ENOENT, EIO
Parameters
errorThe error representing the reason for the failure
Returns
The classification found or nil in case an error occured

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