ROCommonCryptoException
Overview
Indicetes a Common Crypto API error. It is currently used by ROAESEncryptionEnvelope. Common Crypto execptions are also thrown in case of wrong decryption key used.
Location
- Reference: ROAESEncryptionEnvelope.h
- Namespace: RemObjectsSDK
- Ancestry: NSException | ROException | ROCommonCryptoException
errorCode assign
Error code returned by the Common Crypto API
@property (assign) int32_t errorCode
exceptionName (declared in ROException)
+ (nonnull NSString *) exceptionName
exceptionWithMessage: (declared in ROException)
+ (nonnull ROException *) exceptionWithMessage:(nonnull NSString *)aExceptionMessage
Parameters:
- aExceptionMessage:
exceptionWithMessage:direction:errorCode:
Creates an exception instance using all exception specific information.
+ (ROCommonCryptoException *) exceptionWithMessage:(NSString *)aMessage direction:(BOOL)aIsEncryption errorCode:(int32_t)aErrorCode
Parameters:
- aMessage: Text message describing the error condition
- aIsEncryption: Indicates which operation caused the error: YES is for encryption, NO is for decryption
- aErrorCode: Error code returned by the Common Crypto API
fromServer assign (declared in ROException)
This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.
@property (assign) BOOL fromServer
initWithMessage: (declared in ROException)
- (nullable instancetype) initWithMessage:(nonnull NSString *)aExceptionMessage
Parameters:
- aExceptionMessage:
initWithMessage:direction:errorCode:
- (InstanceType) initWithMessage:(NSString *)aMessage direction:(BOOL)aIsEncryption errorCode:(int32_t)aErrorCode
Parameters:
- aMessage:
- aIsEncryption:
- aErrorCode:
initWithMessage:fromServer: (declared in ROException)
- (nullable instancetype) initWithMessage:(nonnull NSString *)aExceptionMessage fromServer:(BOOL)aFromServer
Parameters:
- aExceptionMessage:
- aFromServer:
isEncryption assign
Indicates which operation caused the error: YES is for encryption, NO is for decryption.
@property (assign) BOOL isEncryption
serverStackTrace copy (declared in ROException)
@property (copy) nonnull NSString *serverStackTrace
errorCode assign
Error code returned by the Common Crypto API
@property (assign) int32_t errorCode
fromServer assign (declared in ROException)
This flag is used to distinguish server side exceptions from client side ones. Set to YES for server side exceptions.
@property (assign) BOOL fromServer
isEncryption assign
Indicates which operation caused the error: YES is for encryption, NO is for decryption.
@property (assign) BOOL isEncryption
serverStackTrace copy (declared in ROException)
@property (copy) nonnull NSString *serverStackTrace
exceptionName (declared in ROException)
+ (nonnull NSString *) exceptionName
exceptionWithMessage: (declared in ROException)
+ (nonnull ROException *) exceptionWithMessage:(nonnull NSString *)aExceptionMessage
Parameters:
- aExceptionMessage:
exceptionWithMessage:direction:errorCode:
Creates an exception instance using all exception specific information.
+ (ROCommonCryptoException *) exceptionWithMessage:(NSString *)aMessage direction:(BOOL)aIsEncryption errorCode:(int32_t)aErrorCode
Parameters:
- aMessage: Text message describing the error condition
- aIsEncryption: Indicates which operation caused the error: YES is for encryption, NO is for decryption
- aErrorCode: Error code returned by the Common Crypto API
initWithMessage: (declared in ROException)
- (nullable instancetype) initWithMessage:(nonnull NSString *)aExceptionMessage
Parameters:
- aExceptionMessage:
initWithMessage:direction:errorCode:
- (InstanceType) initWithMessage:(NSString *)aMessage direction:(BOOL)aIsEncryption errorCode:(int32_t)aErrorCode
Parameters:
- aMessage:
- aIsEncryption:
- aErrorCode:
initWithMessage:fromServer: (declared in ROException)
- (nullable instancetype) initWithMessage:(nonnull NSString *)aExceptionMessage fromServer:(BOOL)aFromServer
Parameters:
- aExceptionMessage:
- aFromServer: