EMPinAuthService Class Reference

Inherits from NSObject
Conforms to EMAuthService
Declared in EMPinAuthService.h

Overview

Provides services for authentication with PIN.

+ defaultPinValidationRules

Default PinValidationRules for ‘changePinWithAuthInput’ operation.

+ (NSArray *)defaultPinValidationRules

Return Value

The default pin validation rule set which contains All of rules as follow:

Availability

4.0

Declared In

EMPinAuthService.h

+ serviceWithModule:

Designated constructor. Returns the EMPinAuthService object created using the EMAuthModule

+ (EMPinAuthService *)serviceWithModule:(EMAuthModule *)module

Parameters

module

an instance of EMAuthModule

Return Value

EMPinAuthService module instance.

Availability

4.0

Declared In

EMPinAuthService.h

– createAuthInputWithString:error:

Creates an EMPinAuthInput from from a string.

- (id<EMPinAuthInput>)createAuthInputWithString:(NSString *)str error:(NSError **)error

Parameters

str

The string to securely store. The string will be converted to UTF-8 when stored in the EMPinAuthInput object.
error

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

Return Value

An EMPinAuthInput object that securely stores the data.

Availability

4.0

Declared In

EMPinAuthService.h

– createAuthInputWithString:encoding:error:

Creates an EMPinAuthInput from a string using a specific string encoding.

- (id<EMPinAuthInput>)createAuthInputWithString:(NSString *)str encoding:(NSStringEncoding)encoding error:(NSError **)error

Parameters

str

The string to securely store.
encoding

The string will be converted to this encoding when stored in the EMPinAuthInput object.
error

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

Return Value

An EMPinAuthInput object that securely stores the data.

Availability

4.0

Discussion

Warning: This method does not guarantee that the given string and the given character set are compatible.

Declared In

EMPinAuthService.h

– createAuthInputWithData:error:

Creates an EMPinAuthInput from data.

- (id<EMPinAuthInput>)createAuthInputWithData:(NSData *)data error:(NSError **)error

Parameters

data

The data to securely store.
error

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

Return Value

An EMPinAuthInput object that securely stores the data.

Availability

4.0

Declared In

EMPinAuthService.h

– createAuthInputWithMutableData:wipeSource:error:

Creates an EMPinAuthInput from data.

- (id<EMPinAuthInput>)createAuthInputWithMutableData:(NSMutableData *)data wipeSource:(BOOL)wipeSource error:(NSError **)error

Parameters

data

The data to securely store.
wipeSource

If YES, then the data will be erased if the method returns successfully. Otherwise the input will not be modified.
error

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

Return Value

An EMPinAuthInput object that securely stores the data.

Availability

4.0

Declared In

EMPinAuthService.h

– authMode

Gets an EMPinAuthMode.

- (id<EMPinAuthMode>)authMode

Availability

4.0

Declared In

EMPinAuthService.h

+ setPinValidationRules:

Set PinRules. This will be applied globally.

+ (void)setPinValidationRules:(NSArray *)pinRules

Parameters

pinRules

array of pin rules. See subclasses of EMPinRule.

Availability

4.0

Declared In

EMPinAuthService.h