ThreatLocation Class Reference

#import <ThreatLocation.h>

Inheritance diagram for ThreatLocation:

Instance Methods
(instancetype _Nullable)	- initWithError:
(BOOL)	- setFileName:withError:
(BOOL)	- setArchiveMember:withError:
(BOOL)	- setOffset:withError:
(BOOL)	- setLineNumber:withError:
(BOOL)	- setSurroundingText:withError:
(BOOL)	- setInMetadata:withError:
(NSString *_Nullable)	- fileNameWithError:
(NSString *_Nullable)	- archiveMemberWithError:
(NSNumber *_Nullable)	- offsetWithError:
(BOOL)	- lineNumber:withError:
(NSString *_Nullable)	- surroundingTextWithError:
(BOOL)	- inMetadata:withError:
(NSString *_Nonnull)	- description

Detailed Description

The ThreatLocation class contains the information about the location of a found threat

Method Documentation

archiveMemberWithError:()

- (NSString* _Nullable) archiveMemberWithError:

(NSError *_Nullable *_Nullable)

error

Get location archive member. It represents the name of the file where the threat was found inside the scanned archive. Missing if fileName is not an archive

Parameters

error

The error representing the reason for the failure

Returns

The archive member of the location

description()

- (NSString* _Nonnull) description

Returns threat location description

Returns

The threat location description

fileNameWithError:()

- (NSString* _Nullable) fileNameWithError:

(NSError *_Nullable *_Nullable)

error

Get location file name. It represents the name of the file that was scanned. Nonnull only when scanning files

Parameters

error

The error representing the reason for the failure

Returns

The file name of the location

initWithError:()

- (instancetype _Nullable) initWithError:

(NSError *_Nullable *_Nullable)

error

Initializes a new object immediately after memory for it has been allocated

Note

The designated initializer

Parameters

error

The error representing the reason for the failure

Returns

The initialized object

inMetadata:withError:()

- (BOOL) inMetadata:		(BOOL *_Nonnull)	inMetadata
withError:		(NSError *_Nullable *_Nullable)	error

Get in metadata status. If true, the threat was found in the metadata of the scanned item, false otherwise.

Parameters

error

The error representing the reason for the failure

Returns

The in metadata status

lineNumber:withError:()

- (BOOL) lineNumber:		(NSInteger *_Nonnull)	lineNumber
withError:		(NSError *_Nullable *_Nullable)	error

Get location line number. It represents the line number where the threat was found, -1 means this information is not available

Parameters

lineNumber	Will be set to location line number on success
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

offsetWithError:()

- (NSNumber* _Nullable) offsetWithError:

(NSError *_Nullable *_Nullable)

error

Get location offset. It represents the offset where the threat was found, -1 means this information is not available

Parameters

error

The error representing the reason for the failure

Returns

True on success, false in case an error occured

setArchiveMember:withError:()

- (BOOL) setArchiveMember:		(NSString *_Nonnull)	archiveMember
withError:		(NSError *_Nullable *_Nullable)	error

Set location archive member

Parameters

archiveMember	The new location archive member
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

setFileName:withError:()

- (BOOL) setFileName:		(NSString *_Nonnull)	fileName
withError:		(NSError *_Nullable *_Nullable)	error

Set location file name

Parameters

fileName	The new location file name
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

setInMetadata:withError:()

- (BOOL) setInMetadata:		(BOOL)	inMetadata
withError:		(NSError *_Nullable *_Nullable)	error

Set the in metadata status of the threat location

Parameters

inMetadata	The new in metadata status
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

setLineNumber:withError:()

- (BOOL) setLineNumber:		(NSInteger)	lineNumber
withError:		(NSError *_Nullable *_Nullable)	error

Set location line number

Parameters

lineNumber	The new location line number
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

setOffset:withError:()

- (BOOL) setOffset:		(NSNumber *_Nonnull)	offset
withError:		(NSError *_Nullable *_Nullable)	error

Set location offset

Parameters

offset	The new location offset
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

setSurroundingText:withError:()

- (BOOL) setSurroundingText:		(NSString *_Nonnull)	surroundingText
withError:		(NSError *_Nullable *_Nullable)	error

Set location surrounding text

Parameters

surroundingText	The new location surrounding text
error	The error representing the reason for the failure

Returns

True on success, false in case an error occured

surroundingTextWithError:()

- (NSString* _Nullable) surroundingTextWithError:

(NSError *_Nullable *_Nullable)

error

Get location surrounding text. It represents the surrounding text of the found threat

Parameters

error

The error representing the reason for the failure

Returns

The surrounding text of the location

---

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

• ThreatLocation.h