EMSecureInputBuilder Protocol Reference

Conforms to NSObject
Declared in EMSecureInputBuilder.h

Overview

The input builder class that enables to build a secure pinpad and keypad.

The secure pinpad/keypad does not use any native UIKit keypad but rather draws a custom the UI on the view itself. The use of NSString is limited to minimum to make sure pinpad and keypad has total control of wiping sensitive data after it is used.

Warning: DEPRECATED!!!

– buildWithScrambling:doublePin:onFinishBlock: required method

Creates a Secure Pinpad UIViewController.

- (UIViewController *)buildWithScrambling:(BOOL)isScrambling doublePin:(BOOL)isDoublePin onFinishBlock:(EMSecurePinpadOnFinish)pinEnteredBlock

Parameters

isScrambling

Indicates if the pinpad would have a scrambled key locations. The scrambling is completely random and different for each time the pinpad is shown.
isDoublePin

Indicates if the pinpad would have two text fields to enter the pin. This is useful in case of using the pinpad for a new password and its confirmation. It’s important to be aware that the pinpad itself will NOT perform any comparison of the two pins. The application developer can use method [EMSecureContainer isEqual:] for an equality confirmation.
pinEnteredBlock

Callback block upon the OK button hit on the pinpad.

Return Value

UIViewController that holds the pinpad. This can be fed into a navigation controller or presented as a modal view controller in the current view.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Warning: This method should be called once all the necessary configurations have been done. Note that the default configuration shall be applied for attributes that have not been set to custom values.

See Also

Declared In

EMSecureInputBuilder.h

– setEncoding: required method

Sets the encoding to use when creating the EMPinAuthInput object from the text-based pin.

- (void)setEncoding:(NSStringEncoding)encoding

Parameters

encoding

The encoding method to use when generating byte array from the character password.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Warning: This method is especially dedicated for existing applications that are currently using their own keypad and would like to use EZIO keypad in replacement. For those applications, the EMPinAuthInput used to be generated from a NSString object given an encoding method. So, the application developers need to make sure to use the same (or compatible) encoding method to allow the generated bytes are correct.

Declared In

EMSecureInputBuilder.h

– wipe required method

Wipes all the sensitive data of the pinpad builder. The method would also be automatically triggered upon the release of this object on the autorelease pool of the current thread.

It’s recommended to call this method at the end of the callback block EMSecurePinpadOnFinish. See definition of EMSecurePinpadOnFinish above.
Note: Other non-sensitive configuration such as color setting and text-label setting won’t be reset in this function.

- (void)wipe

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setCharacterArray: required method

Sets the character array, extracted from the passed-by string of characters. IMPORTANT: At present, only Alphanumeric characters (0 -> 9, A -> Z and a->z) are supported. Passing in any other characters would cause an NSException.

- (void)setCharacterArray:(NSString *)charArr

Parameters

charArr

String of character array to be used to display on the pinpad.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setNumberOfRows: required method

Sets the preferred number of rows. The on-display number of rows depend on the number of characters in the character array and some other configurations. Refer to Programmer’s Guide for the accepted range of values.

- (void)setNumberOfRows:(int)numOfRows

Parameters

numOfRows

Preferred number of rows to display.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setNumberOfColumns: required method

Sets the preferred number of columns. The on-display number of columns depend on the number of characters in the character array and some other configurations. Refer to Programmer’s Guide for the accepted range of values.

- (void)setNumberOfColumns:(int)numOfCols

Parameters

numOfCols

Preferred number of columns to display.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setMinimumInputLength: required method

Setes the minimum input length. Refer to Programmer’s Guide for the accepted range of values.

- (void)setMinimumInputLength:(int)minLen

Parameters

minLen

The pinpad would make sure the user has entered at least minLen characters before he/she can hit OK.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setMaximumInputLength: required method

Sets the maximum input length. Refer to Programmer’s Guide for the accepted range of values.

- (void)setMaximumInputLength:(int)maxLen

Parameters

maxLen

The pinpad would make sure the user cannot enter more than maxLen number of characters.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setTextLabel: required method

Sets the pin’s text label.

- (void)setTextLabel:(NSString *)text

Parameters

text

Text string to be set. There is no specific check on the length of the text, but the text field stretches across the width of the screen.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setSecondTextLabel: required method

Sets the second pin input’s text label.

This attribute is useful only in double-password mode where there are two input fields to enter the pins.

- (void)setSecondTextLabel:(NSString *)text

Parameters

text

Text string to be set. There is no specific check on the length of the text, but the text field stretches across the width of the screen.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setLabelTextColor: required method

Sets the pin’s text label’s color. This value is used for both first and second pin input labels.

- (void)setLabelTextColor:(UIColor *)color

Parameters

color

Color to set for the pin’s text labels.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonSpacing: required method

Sets the spacing between the keys on the screen. Refer to Programmer’s Guide for the accepted range of values.

- (void)setButtonSpacing:(int)buttonSpacing

Parameters

buttonSpacing

The distance between the keys in terms of pixels.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setScreenBackgroundColor: required method

Sets the background color of the pinpad’s screen.

- (void)setScreenBackgroundColor:(UIColor *)backgroundColor

Parameters

backgroundColor

Color to set for the background.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonCharacterColorNormal: required method

Sets the key’s character color when it’s being displayed (normal condition).

- (void)setButtonCharacterColorNormal:(UIColor *)color

Parameters

color

Color to set for the key’s character in normal condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonCharacterColorSelected: required method

Sets the key’s character color when it’s tapped (selected condition).

- (void)setButtonCharacterColorSelected:(UIColor *)color

Parameters

color

Color to set for the key’s character in selected condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonCharacterColorDisabled: required method

Sets the key’s character color when it’s disabled (disabled condition). This color is typically used for function keys such as Ok or Delete buttons.

- (void)setButtonCharacterColorDisabled:(UIColor *)color

Parameters

color

Color to set for the key’s character in disabled condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientNormalStart: required method

Sets the key’s background gradient starting color when it’s being displayed (normal condition).

- (void)setButtonGradientNormalStart:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient start in normal condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientNormalEnd: required method

Sets the key’s background gradient ending color when it’s being displayed (normal condition).

- (void)setButtonGradientNormalEnd:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient end in normal condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientSelectedStart: required method

Sets the key’s background gradient starting color when it’s tapped (selected condition).

- (void)setButtonGradientSelectedStart:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient start in selected condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientSelectedEnd: required method

Sets the key’s background gradient ending color when it’s tapped (selected condition).

- (void)setButtonGradientSelectedEnd:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient end in selected condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientDisabledStart: required method

Sets the key’s background gradient starting color when it’s disabled (disabled condition). This color is typically used for function keys such as Ok or Delete buttons.

- (void)setButtonGradientDisabledStart:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient start in disabled condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setButtonGradientDisabledEnd: required method

Sets the key’s background gradient ending color when it’s disabled (disabled condition). This color is typically used for function keys such as Ok or Delete buttons.

- (void)setButtonGradientDisabledEnd:(UIColor *)color

Parameters

color

Color to set for the key’s background gradient end in disabled condition.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setTextBoxBorderUnFocussedColor: required method

Sets the key’s text border color when it’s unfocussed (unselected condition).

- (void)setTextBoxBorderUnFocussedColor:(UIColor *)color

Parameters

color

Color to set key’s text border color when it’s unfocussed.

Availability

2.6

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setTextBoxBorderFocussedColor: required method

Sets the key’s text border color when it’s focussed (selected condition).

- (void)setTextBoxBorderFocussedColor:(UIColor *)color

Parameters

color

Color to set key’s text border color when it’s focussed.

Availability

2.6

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setVisibleButtonPress: required method

Sets the if the button would be highlighted upon pressed.

- (void)setVisibleButtonPress:(BOOL)isVisible

Parameters

isVisible

YES to highlight the button upon pressed, NO otherwise.

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setAutomaticEnabledOk: required method

Enable this attribute to have the effect that the OK button is only enabled when minimum number of characters have been entered by the user.

- (void)setAutomaticEnabledOk:(BOOL)autoEnabled

Parameters

autoEnabled

YES to indicate the OK button shall be disabled and enabled automatically by the library according to the number of characters input by user. NO to indicate the OK button shall always be enabled.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h

– setAutomaticOk: required method

Allows to automatically call OK button clicked event.

When set on, the library would trigger the Ok button clicked automatically when the following conditions have been met: - The minimum and maximum input length are configured to be the same (see setMinimumInputLength: and setMaximumInputLength:). - User has entered up to the maximum number of characters needed.

- (void)setAutomaticOk:(BOOL)autoTriggered

Parameters

autoTriggered

YES to enable the OK button to be triggered when the conditions are met. NO to disable this behavior.

Availability

2.5

Discussion

Warning: DEPRECATED!!!

Declared In

EMSecureInputBuilder.h