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

#import <ThreatInfosFuture.h>

Inheritance diagram for ThreatInfosFuture:

Instance Methods

(BOOL) - isResultReady:withError:
 
(NSArray< ThreatInfo * > *_Nullable) - resultWithError:
 

Detailed Description

ThreatInfosFuture class provides the means to manipulate and check the status of the scan without handler it represents and to retrieve the threats found on scan.

Method Documentation

◆ isResultReady:withError:()

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

Checks if the result of the scan is ready.

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

◆ resultWithError:()

- (NSArray<ThreatInfo *> * _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_ELICENSE, SENSITIVITYIO_EINVALIDLICENSE, SENSITIVITYIO_ELICENSEEXPIRED, SENSITIVITYIO_ESETTINGS, ENOENT
Parameters
errorThe error representing the reason for the failure
Returns
The threats found or nil in case an error occured

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