ISError Class Reference

Inherits from NSObject
Declared in ISError.h

Overview

Class used to represent an Insiteo error.

  code

Error enum code.

@property (nonatomic, readonly) ISEErrorCode code

Declared In

ISError.h

  reason

Error enum reason.

@property (nonatomic, readonly) ISEErrorReason reason

Declared In

ISError.h

  message

Error message.

@property (nonatomic, readonly) NSString *message

Declared In

ISError.h

– initWithCode:andReason:

Main constructor.

- (instancetype)initWithCode:(ISEErrorCode)code andReason:(ISEErrorReason)reason

Parameters

code

Error code.
reason

Error reason.

Declared In

ISError.h

– initWithCode:andReason:andMessage:

Secondary constructor.

- (instancetype)initWithCode:(ISEErrorCode)code andReason:(ISEErrorReason)reason andMessage:(NSString *)message

Parameters

code

Error code.
reason

Error reason.
message

Error message.

Declared In

ISError.h

+ ISErrorWithCode:andReason:

Static main constructor.

+ (instancetype)ISErrorWithCode:(ISEErrorCode)code andReason:(ISEErrorReason)reason

Parameters

code

Error code.
reason

Error reason.

Declared In

ISError.h

+ ISErrorWithCode:andReason:andMessage:

Static main constructor.

+ (instancetype)ISErrorWithCode:(ISEErrorCode)code andReason:(ISEErrorReason)reason andMessage:(NSString *)message

Parameters

code

Error code.
reason

Error reason.
message

Error message.

Declared In

ISError.h

+ getErrorCodeToString:

Static method used to get the error code NSString representation.

+ (NSString *)getErrorCodeToString:(ISEErrorCode)code

Parameters

code

Error code.

Return Value

Error code NSString representation.

Declared In

ISError.h

+ getErrorReasonToString:

Static method used to get the error reason NSString representation.

+ (NSString *)getErrorReasonToString:(ISEErrorReason)reason

Parameters

reason

Error reason.

Return Value

Error reason NSString representation.

Declared In

ISError.h

+ getErrorReasonFromStatusCode:

Static method used to get an error reason from a given HTTP status code.

+ (ISEErrorReason)getErrorReasonFromStatusCode:(NSInteger)statusCode

Parameters

statusCode

HTTP status code.

Return Value

An error reason (default: ISEErrorReasonUnknown).

Declared In

ISError.h