UserInputEvent Class Reference

Inheritance diagram for UserInputEvent:

Public Member Functions
String	getInputType ()
String	getDefaultValue ()
RequestParameters	getRequestParameters ()
Values	getValues ()
Response	generateResponse ()
String	getType ()
	UserInputEvent (Parcel in, int parcelVersion)
void	writeToParcel (Parcel dest, int flags)
void	setParcelVersion (int targetParcelVersion)
String	getValue ()
BigDecimal	getDecimalValue ()
Bitmap	getSignatureBitmap ()
Public Member Functions inherited from TransactionEvent
String	getInvoiceId ()
Transaction	getTransaction ()
String	getType ()
Response	generateResponse ()
	TransactionEvent (Parcel in, int parcelVersion)
void	setParcelVersion (int targetParcelVersion)
void	writeToParcel (Parcel dest, int flags)
Public Member Functions inherited from CommerceEvent
String	getType ()
Response	generateResponse ()
	CommerceEvent (Parcel in, int parcelVersion)
void	writeToParcel (Parcel dest, int flags)
Public Member Functions inherited from Status
String	getSessionId ()
int	getStatus ()
String	getType ()
String	getMessage ()
	Status (Parcel in, int parcelVersion)
void	writeToParcel (Parcel dest, int flags)
int	describeContents ()
Public Member Functions inherited from BaseParcel
	BaseParcel (Parcel in, int parcelVersion)
void	setParcelVersion (int targetParcelVersion)
final int	getParcelVersion ()
String	getClassName ()
void	writeToParcel (Parcel dest, int flags)
int	describeContents ()

Static Public Attributes
static final String	RECEIVED_TYPE = "USER_INPUT_RECEIVED_EVENT"
static final String	REQUEST_TYPE = "USER_INPUT_REQUESTED_EVENT"
static final String	TYPE = "USER_INPUT_EVENT"
static final String	INPUT_MASK_CAPABILITY = "INPUT_MASK_CAPABILITY"
static final Parcelable.Creator< UserInputEvent >	CREATOR
Static Public Attributes inherited from TransactionEvent
static final String	TRANSACTION_NOTIFICATION = "TRANSACTION_NOTIFICATION"
static final String	TRANSACTION_REQUEST = "TRANSACTION_REQUEST"
static final String	TRANSACTION_PAYMENT_STARTED = "TRANSACTION_PAYMENT_STARTED"
static final String	TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION = "TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION"
static final String	TRANSACTION_PAYMENT_COMPLETED = "TRANSACTION_PAYMENT_COMPLETED"
static final String	TRANSACTION_STARTED = "TRANSACTION_STARTED"
static final String	TRANSACTION_ENDED = "TRANSACTION_ENDED"
static final String	TRANSACTION_ERROR = "TRANSACTION_ERROR"
static final String	TRANSACTION_FAILED = "TRANSACTION_FAILED"
static final String	LOGIN_COMPLETED = "LOGIN_COMPLETED"
static final String	LOGOUT_COMPLETED = "LOGOUT_COMPLETED"
static final Parcelable.Creator< TransactionEvent >	CREATOR
Static Public Attributes inherited from CommerceEvent
static final String	SESSION_STARTED = "SESSION_STARTED"
static final String	SESSION_RESUMED = "SESSION_RESUMED"
static final String	SESSION_ENDED = "SESSION_ENDED"
static final String	SESSION_CLOSED = "SESSION_CLOSED"
static final String	SESSION_ERROR = "SESSION_ERROR"
static final String	SESSION_START_FAILED = "SESSION_START_FAILED"
static final String	SESSION_RESUME_FAILED = "SESSION_RESUME_FAILED"
static final String	SESSION_END_FAILED = "SESSION_END_FAILED"
static final Parcelable.Creator< CommerceEvent >	CREATOR
Static Public Attributes inherited from Status
static final String	STATUS_SUCCESS = "SUCCESS"
static final String	STATUS_ERROR = "ERROR"
static final Parcelable.Creator< Status >	CREATOR
Static Public Attributes inherited from BaseParcel
static final Parcelable.Creator< BaseParcel >	CREATOR

Additional Inherited Members
Protected Member Functions inherited from TransactionEvent
String	getEventId ()
void	setEventId (String eventId)
	TransactionEvent (String sessionId, int status, String type, String message)
Protected Member Functions inherited from CommerceEvent
	CommerceEvent (String sessionId, int status, String type, String message)
String	getEventId ()
void	setEventId (String eventId)
Protected Member Functions inherited from Status
	Status (String sessionId, int status, String type, String message)
Static Protected Member Functions inherited from BaseParcel
static void	safelySetParcelVersion (final int targetParcelVersion, @Nullable BaseParcel item)
static void	safelySetParcelVersion (final int targetParcelVersion, @Nullable List<? extends BaseParcel > items)
static< T extends BaseParcel > void	safelySetParcelVersion (final int targetParcelVersion, @Nullable T[] items)

Detailed Description

Either contains the information requested from the customer, or enables sending a response to collect information from the cashier.

Definition at line 20 of file UserInputEvent.java.

Constructor & Destructor Documentation

UserInputEvent()

UserInputEvent	(	Parcel	in,
		int	parcelVersion
	)

Reconstruct the object from a parcel. This should only be used by the system.

Definition at line 124 of file UserInputEvent.java.

Member Function Documentation

generateResponse()

Response generateResponse

(

)

Generates a Response object for return to the service.

Definition at line 82 of file UserInputEvent.java.

getDecimalValue()

BigDecimal getDecimalValue

(

)

Use getValues() with Values#getNumericValue() instead.

Definition at line 187 of file UserInputEvent.java.

getDefaultValue()

String getDefaultValue

(

)

If getType() is TYPE, returns the default value from the original request, otherwise this returns the requested default value.

Definition at line 59 of file UserInputEvent.java.

getInputType()

String getInputType

(

)

If getType() is TYPE, returns the requested input type, else if this is the REQUEST_TYPE, returns the input type that is being requested.

Definition at line 51 of file UserInputEvent.java.

getRequestParameters()

RequestParameters getRequestParameters

(

)

Returns the current RequestParameters if this is of type REQUEST_TYPE.

Definition at line 66 of file UserInputEvent.java.

getSignatureBitmap()

Bitmap getSignatureBitmap

(

)

Use getValues() with Values instead.

Definition at line 200 of file UserInputEvent.java.

getValue()

String getValue

(

)

Use getValues() with Values#getValue() instead.

Definition at line 174 of file UserInputEvent.java.

getValues()

Values getValues

(

)

If getType() is TYPE, returns the values as collected by the terminal, otherwise this will be null.

Definition at line 74 of file UserInputEvent.java.

Member Data Documentation

CREATOR

final Parcelable.Creator<UserInputEvent> CREATOR

static

Initial value:

=
            new UserInputEvent.ParcelCreator<UserInputEvent>()

Definition at line 166 of file UserInputEvent.java.

INPUT_MASK_CAPABILITY

final String INPUT_MASK_CAPABILITY = "INPUT_MASK_CAPABILITY"

static

Enables querying if the device supports masking the input.

Definition at line 41 of file UserInputEvent.java.

RECEIVED_TYPE

final String RECEIVED_TYPE = "USER_INPUT_RECEIVED_EVENT"

static

The type when responding to the TransactionManager#requestUserInput(String, String, String) or the TransactionManager#presentUserOptions(String, String[]) methods.

Definition at line 27 of file UserInputEvent.java.

REQUEST_TYPE

final String REQUEST_TYPE = "USER_INPUT_REQUESTED_EVENT"

static

The type when the terminal/POI is requesting input from the cashier.

Definition at line 32 of file UserInputEvent.java.

TYPE

final String TYPE = "USER_INPUT_EVENT"

static

Use RECEIVED_TYPE instead.

Definition at line 36 of file UserInputEvent.java.

---

The documentation for this class was generated from the following file:

• src/main/java/com/verifone/commerce/payment/UserInputEvent.java