Logo
Developer SDK
Version 1.9.632.913d652c-152450467.
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
TransactionEvent Class Reference
Inheritance diagram for TransactionEvent:
CommerceEvent Status BaseParcel AmountAdjustedEvent BasketAdjustedEvent BasketEvent CardInformationReceivedEvent DeviceInformationReceivedEvent LoyaltyReceivedEvent PaymentCompletedEvent ReceiptDeliveryMethodEvent ReconciliationEvent TransactionQueryEvent StoredValueCardEvent TransactionEndedEvent UserInputEvent UserOptionSelectedEvent

Public Member Functions

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 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
 

Protected Member Functions

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)
 

Additional Inherited Members

- 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

The parent class for the events that may occur during a transaction. This is only ever generated by the underlying service, and passed to the appropriate listener.

Definition at line 24 of file TransactionEvent.java.

Constructor & Destructor Documentation

◆ TransactionEvent() [1/2]

TransactionEvent ( String  sessionId,
int  status,
String  type,
String  message 
)
protected

For internal use to generate the initial event.

Definition at line 117 of file TransactionEvent.java.

◆ TransactionEvent() [2/2]

TransactionEvent ( Parcel  in,
int  parcelVersion 
)

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

Definition at line 122 of file TransactionEvent.java.

Member Function Documentation

◆ generateResponse()

Response generateResponse ( )

The generator method for generating the appropriate response for the current event.

Returns
empty response when a standard transaction event. Child classes may implement appropriate responses as needed.

Definition at line 76 of file TransactionEvent.java.

◆ getInvoiceId()

String getInvoiceId ( )

The invoice ID for the transaction as a reference.

Definition at line 55 of file TransactionEvent.java.

◆ getTransaction()

Transaction getTransaction ( )

The transaction associated with this event.

Definition at line 60 of file TransactionEvent.java.

◆ getType()

String getType ( )

Returns the Transaction Event constants in addition to the CommerceEvent and Status constants. Overridden here only to provide the appropriate documentation.

Definition at line 68 of file TransactionEvent.java.

Member Data Documentation

◆ CREATOR

final Parcelable.Creator<TransactionEvent> CREATOR
static
Initial value:
=
(Parcelable.Creator<TransactionEvent>)
new TransactionEvent.ParcelCreator<TransactionEvent>()

Definition at line 145 of file TransactionEvent.java.

◆ LOGIN_COMPLETED

final String LOGIN_COMPLETED = "LOGIN_COMPLETED"
static

The login process is complete, check the status for the success/failure of the attempt.

Definition at line 47 of file TransactionEvent.java.

◆ LOGOUT_COMPLETED

final String LOGOUT_COMPLETED = "LOGOUT_COMPLETED"
static

The logout process is complete, check the status for the success/failure of the attempt.

Definition at line 49 of file TransactionEvent.java.

◆ TRANSACTION_ENDED

final String TRANSACTION_ENDED = "TRANSACTION_ENDED"
static

The event type when an action has ended for non-Payment types.

Definition at line 41 of file TransactionEvent.java.

◆ TRANSACTION_ERROR

final String TRANSACTION_ERROR = "TRANSACTION_ERROR"
static

A general type when an error has occurred during the transaction.

Definition at line 43 of file TransactionEvent.java.

◆ TRANSACTION_FAILED

final String TRANSACTION_FAILED = "TRANSACTION_FAILED"
static

The transaction has failed. It will need to be started again.

Definition at line 45 of file TransactionEvent.java.

◆ TRANSACTION_NOTIFICATION

final String TRANSACTION_NOTIFICATION = "TRANSACTION_NOTIFICATION"
static

A general transaction event notifying listeners that something has happened.

Definition at line 26 of file TransactionEvent.java.

◆ TRANSACTION_PAYMENT_COMPLETED

final String TRANSACTION_PAYMENT_COMPLETED = "TRANSACTION_PAYMENT_COMPLETED"
static

The event type when a payment has been completed.

Definition at line 37 of file TransactionEvent.java.

◆ TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION

final String TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION = "TRANSACTION_PAYMENT_REQUIRES_ONLINE_AUTHORIZATION"
static

The event type when a payment requires online authorization. An event with this type will only be sent when the client is performing online authorization itself.

Definition at line 35 of file TransactionEvent.java.

◆ TRANSACTION_PAYMENT_STARTED

final String TRANSACTION_PAYMENT_STARTED = "TRANSACTION_PAYMENT_STARTED"
static

The event type when a payment has started.

Definition at line 30 of file TransactionEvent.java.

◆ TRANSACTION_REQUEST

final String TRANSACTION_REQUEST = "TRANSACTION_REQUEST"
static

A general transaction event requesting information from listeners.

Definition at line 28 of file TransactionEvent.java.

◆ TRANSACTION_STARTED

final String TRANSACTION_STARTED = "TRANSACTION_STARTED"
static

The event type when an action has started for non-Payment types.

Definition at line 39 of file TransactionEvent.java.

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

This document is the confidential property of Verifone, Inc. Any reproduction or distribution of this document, in whole or in part, or the disclosure of any of the information contained herein, without the prior written consent of Verifone, Inc. is prohibited. This document and any supplemental material supplied as part of any review must be returned to Verifone, Inc. upon request. Notice: This document may go through material revisions over time. While the Company will make every effort to keep readers updated as changes occur, care must be taken by the reader to make sure they are reading the latest version. Version numbers appear in the title page and revision history page of this document. All rights reserved. Verifone, the Verifone logo are either trademarks or registered trademarks of Verifone in the United States and/or other countries. All other trademarks or brand names are properties of their respective holders.