Package com.thalesgroup.gemalto.d1.securecarddisplay

Class CardDetailsUI

java.lang.Object

com.thalesgroup.gemalto.d1.securecarddisplay.CardDetailsUI

public abstract class CardDetailsUI
extends Object

A type to represent the UI component required to display the card details securely. It is an enhanced version of SecureCardDisplayService.getCardDetails(String) API. By using CardDetailsUI API, DisplayTextView#getText() will always return empty. To retrieve the value, DisplayTextView.insecureCopyToClipboard() should be called.

Since:

4.4.0

Constructor Summary

Constructors

Constructor	Description
CardDetailsUI()

Method Summary

Modifier and Type	Method	Description
static CardDetailsUI	getInstance(DisplayTextView panTextView, DisplayTextView expiryDateTextView, DisplayTextView cvvTextView, DisplayTextView cardHolderNameTextView)	Initializer to construct a CardDetailsUI.
abstract void	maskCardDetails()	To mask card details.
abstract void	setExpiryDateFormat(String expiryDateFormat)	To set date format used in expiry date.
abstract void	setPanMaskCharacter(String panMaskCharacter)	To set mask character for PAN.
abstract void	setPanSeparatorCharacter(String panSeparatorCharacter)	To set separator character for PAN every 4 characters, e.g.
abstract Task<Void>	showCardDetails()	To show card details securely.
abstract void	wipe()	Wipe the content of the displayed card details.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CardDetailsUI

public CardDetailsUI()

Method Details

getInstance

public static CardDetailsUI getInstance(@Nullable
 DisplayTextView panTextView,
 @Nullable
 DisplayTextView expiryDateTextView,
 @Nullable
 DisplayTextView cvvTextView,
 @Nullable
 DisplayTextView cardHolderNameTextView)

Initializer to construct a CardDetailsUI.

Parameters:

panTextView - The text view to display the PAN securely.

expiryDateTextView - The text view to display the expiry date securely.

cvvTextView - The text view to display the CVV securely.

cardHolderNameTextView - The text view to display the card holder name securely.

setPanSeparatorCharacter

public abstract void setPanSeparatorCharacter(@NonNull
 String panSeparatorCharacter)

To set separator character for PAN every 4 characters, e.g. when the separator character is ' ', PAN is displayed 1234 5678 1234 5678. By default, it is set to ' '.

Parameters:

panSeparatorCharacter - a string for PAN separation

setPanMaskCharacter

public abstract void setPanMaskCharacter(@NonNull
 String panMaskCharacter)

To set mask character for PAN. It is used in `maskCardDetails()`. By default, it is set to '*'.

Parameters:

panMaskCharacter - a string for PAN mask

setExpiryDateFormat

public abstract void setExpiryDateFormat(@NonNull
 String expiryDateFormat)

To set date format used in expiry date. By default, it is set to "MM/yy".

Parameters:

expiryDateFormat - a string for expiry date format

See Also:

• SimpleDateFormat for acceptable date format.

showCardDetails

public abstract Task<Void> showCardDetails()

To show card details securely.

When SecureCardDisplayService.displayCardDetails(String, CardDetailsUI) is called, it is showing the card details; thus there is no need to call this API.

This API should only be called after successful SecureCardDisplayService.displayCardDetails(String, CardDetailsUI). It is convenient method to show the card details again after maskCardDetails() is called.

Returns:

A Task. Please refer Task for more details.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CORE
• D1Exception.ErrorCode.ERROR_CARD_NOT_FOUND

maskCardDetails

public abstract void maskCardDetails()

To mask card details.

This API update the UI so that only last 4 digit and expiry date is visible. CVV and card holder name is removed.

To show the card details, call showCardDetails().

wipe

public abstract void wipe()

Wipe the content of the displayed card details.