Interface TerminalListener

Listener for asynchronous terminal events.

Namespace: SIX.TimApi

Assembly: TimApi.dll

Syntax

public interface TerminalListener

Methods

ActivateCompleted(TimEvent, ActivateResponse)

Called if an Terminal.activateAsync() started request finished.

Declaration

void ActivateCompleted(TimEvent tevent, ActivateResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ActivateResponse	data	Contains activation sequence counter and print information for the merchant.

ActivateServiceMenuCompleted(TimEvent)

Called if an Terminal.activateServiceMenuAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void ActivateServiceMenuCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

AgeCheckCompleted(TimEvent, TransactionInformation)

Called if an Terminal.AgeCheckAsync() started request finished.

Supported only if Guides.REMOTE is enabled.

Declaration

void AgeCheckCompleted(TimEvent tevent, TransactionInformation data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
TransactionInformation	data	Contains transaction result information and print information for the merchant and cardholder.

ApplicationInformationCompleted(TimEvent)

Called if an Terminal.applicationInformationAsync() started request finished.

Declaration

void ApplicationInformationCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

BalanceCompleted(TimEvent, BalanceResponse)

Called if an Terminal.balanceAsync() started request finished.

Declaration

void BalanceCompleted(TimEvent tevent, BalanceResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
BalanceResponse	data	Contains counters and print information for the merchant.

BalanceInquiryCompleted(TimEvent, BalanceInquiryResponse)

Called if an Terminal.balanceInquiryAsync() started request finished.

Supported only if Guides.ADVANCED_RETAIL is enabled.

Declaration

void BalanceInquiryCompleted(TimEvent tevent, BalanceInquiryResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
BalanceInquiryResponse	data

ChangeSettingsCompleted(TimEvent)

Called if an Terminal.changeSettingsAsync(java.util.Map) started request finished.

Declaration

void ChangeSettingsCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

ClientIdentificationCompleted(TimEvent, ClientIdentificationResponse)

Called if an Terminal.clientIdentification() or Terminal.clientIdentificationAsync() started request finished.

Declaration

void ClientIdentificationCompleted(TimEvent tevent, ClientIdentificationResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ClientIdentificationResponse	data	Contains result information and print information for the merchant and cardholder.

CloseDialogModeCompleted(TimEvent)

Called if an Terminal.closeDialogModeAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void CloseDialogModeCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

CloseMaintenanceWindowCompleted(TimEvent)

Called if an Terminal.closeMaintenanceWindowAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void CloseMaintenanceWindowCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

CloseReaderCompleted(TimEvent)

Called if an Terminal.closeReaderAsync started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void CloseReaderCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

CommitCompleted(TimEvent, PrintData)

Called if an Terminal.commitAsync() started request finished.

Declaration

void CommitCompleted(TimEvent tevent, PrintData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
PrintData	data

ConnectCompleted(TimEvent)

Called if an Terminal.connect() started request finished.

Declaration

void ConnectCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

CounterRequestCompleted(TimEvent, CounterList)

Called if an Terminal.counterRequestAsync(com.six.timapi.constants.CounterType) started request finished.

Declaration

void CounterRequestCompleted(TimEvent tevent, CounterList data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
CounterList	data	Contains counters.

DccRatesCompleted(TimEvent, PrintData)

Called if an Terminal.dccRatesAsync() started request finished.

Declaration

void DccRatesCompleted(TimEvent tevent, PrintData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
PrintData	data	Contains print information for merchant.

DeactivateCompleted(TimEvent, DeactivateResponse)

Called if an Terminal.deactivateAsync() started request finished.

Declaration

void DeactivateCompleted(TimEvent tevent, DeactivateResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
DeactivateResponse	data	Contains counters and print information for the merchant.

DeferredAuth(Terminal, TransactionResponse)

Called if a Deferred Authorization Notification has been received.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void DeferredAuth(Terminal terminal, TransactionResponse response)

Parameters

Type	Name	Description
Terminal	terminal
TransactionResponse	response

DeviceMaintenanceCompleted(TimEvent)

Called if an Terminal.deviceMaintenanceAsync() started request finished.

Supported only if Guides.REMOTE is enabled.

Declaration

void DeviceMaintenanceCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

Disconnected(Terminal, TimException)

Connection to terminal closed. Called if user disconnected or connection has been lost.

Declaration

void Disconnected(Terminal terminal, TimException exception)

Parameters

Type	Name	Description
Terminal	terminal	Terminal sending the notification.
TimException	exception

EjectCardCompleted(TimEvent)

Called if an Terminal.ejectCardAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void EjectCardCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

ErrorNotification(Terminal, TimException)

Called if a terminal send an Error Notification.

Declaration

void ErrorNotification(Terminal terminal, TimException error)

Parameters

Type	Name	Description
Terminal	terminal
TimException	error

FinishCheckoutCompleted(TimEvent, VasCheckoutInformation)

Called if an Terminal.finishCheckoutAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void FinishCheckoutCompleted(TimEvent tevent, VasCheckoutInformation data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
VasCheckoutInformation	data

HardwareInformationCompleted(TimEvent, HardwareInformationResponse)

Called if an Terminal.hardwareInformationAsync started request finished.

Declaration

void HardwareInformationCompleted(TimEvent tevent, HardwareInformationResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
HardwareInformationResponse	data	Contains information about EFT Terminal hardware and EMV kernels and configuration parameters supported by the EFT Terminal.

InitTransactionCompleted(TimEvent, CardData)

Called if an Terminal.initTransactionAsync(boolean, Amount) started request finished.

Declaration

void InitTransactionCompleted(TimEvent tevent, CardData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
CardData	data

InitTransactionWithDialogCompleted(TimEvent, InitTransactionResponse)

Called if an Terminal.initTransactionWithDialogAsync(Amount, ShowDialogRequest) started request finished.

Declaration

void InitTransactionWithDialogCompleted(TimEvent tevent, InitTransactionResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
InitTransactionResponse	data

KeyPressed(Terminal, Reason)

Called if a Key Pressed Notification has been received.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void KeyPressed(Terminal terminal, Reason reason)

Parameters

Type	Name	Description
Terminal	terminal
Reason	reason

LoginCompleted(TimEvent)

Called if an Terminal.loginAsync() started request finished.

Declaration

void LoginCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

LogoutCompleted(TimEvent)

Called if an Terminal.logoutAsync() started request finished.

Declaration

void LogoutCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

LoyaltyDataCompleted(TimEvent, CardData)

Called if an Terminal.loyaltyDataAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void LoyaltyDataCompleted(TimEvent tevent, CardData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
CardData	data

MobileTopupCompleted(TimEvent, MobileTopupData)

Called if an Terminal.mobileTopupAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void MobileTopupCompleted(TimEvent tevent, MobileTopupData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
MobileTopupData	data

MobileTopupIssuerInfoCompleted(TimEvent, List<MobileTopupValue>)

Called if an Terminal.mobileTopupIssuerInfoAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void MobileTopupIssuerInfoCompleted(TimEvent tevent, List<MobileTopupValue> data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
List<MobileTopupValue>	data

OpenDialogModeCompleted(TimEvent)

Called if an Terminal.openDialogModeAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void OpenDialogModeCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

OpenMaintenanceWindowCompleted(TimEvent)

Called if an Terminal.openMaintenanceWindowAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void OpenMaintenanceWindowCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

OpenReaderCompleted(TimEvent)

Called if an Terminal.openReaderAsync() started request finished.

Supported only if Guides.UNATTENDED is enabled.

Declaration

void OpenReaderCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

PrintOnTerminalCompleted(TimEvent)

Called if an Terminal.printOnTerminalAsync() started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void PrintOnTerminalCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

ProvideLoyaltyBasketCompleted(TimEvent, List<LoyaltyItem>)

Called if an Terminal.provideLoyaltyBasketAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void ProvideLoyaltyBasketCompleted(TimEvent tevent, List<LoyaltyItem> data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
List<LoyaltyItem>	data

ProvideVasResultCompleted(TimEvent, VasResult)

Called if an Terminal.provideVasResultAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void ProvideVasResultCompleted(TimEvent tevent, VasResult data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
VasResult	data

RebootCompleted(TimEvent)

Called if an Terminal.rebootAsync() started request finished.

Declaration

void RebootCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

ReceiptRequestCompleted(TimEvent, ReceiptRequestResponse)

Called if an Terminal.receiptRequestAsync(com.six.timapi.constants.ReceiptRequestType) started request finished.

Declaration

void ReceiptRequestCompleted(TimEvent tevent, ReceiptRequestResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ReceiptRequestResponse	data	Contains all requested receipts up to a maximum number of receipts the EFT Terminal can send. if HasMoreReceipts is True not all receipts could be send by the EFT Terminal. call ReceiptRequest again to obtain more receipts.

ReconciliationCompleted(TimEvent, ReconciliationResponse)

Called if an Terminal.reconciliationAsync() started request finished.

Declaration

void ReconciliationCompleted(TimEvent tevent, ReconciliationResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ReconciliationResponse	data	Contains counters and print information for the merchant.

ReconfigCompleted(TimEvent, PrintData)

Called if an Terminal.reconfigAsync() started request finished.

Declaration

void ReconfigCompleted(TimEvent tevent, PrintData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
PrintData	data	Contains print information for the merchant.

RequestAliasCompleted(TimEvent, String)

Called if an Terminal.requestAlias() started request finished.

Declaration

void RequestAliasCompleted(TimEvent tevent, string data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
System.String	data

RollbackCompleted(TimEvent, PrintData)

Called if an Terminal.rollbackAsync() started request finished.

Declaration

void RollbackCompleted(TimEvent tevent, PrintData data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
PrintData	data	Contains print information for the merchant and cardholder.

Screenshot(Terminal, ScreenshotInformation)

Called if a Screenshot Notification has been received.

Supported only if Guides.REMOTE is enabled.

Declaration

void Screenshot(Terminal terminal, ScreenshotInformation info)

Parameters

Type	Name	Description
Terminal	terminal
ScreenshotInformation	info

SendCardCommandCompleted(TimEvent, List<CommandResponse>)

Called if an Terminal.sendCardCommand(List) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void SendCardCommandCompleted(TimEvent tevent, List<CommandResponse> data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
List<CommandResponse>	data

ShowDialogCompleted(TimEvent, ShowDialogResponse)

Called if an Terminal.showDialogAsync(ShowDialogRequest) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void ShowDialogCompleted(TimEvent tevent, ShowDialogResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ShowDialogResponse	data

ShowSignatureCaptureCompleted(TimEvent, ShowSignatureCaptureResponse)

Called if an Terminal.showSignatureCaptureAsync(ShowSignatureCaptureRequest) started request finished.

Supported only if Guides.DIALOG is enabled.

Declaration

void ShowSignatureCaptureCompleted(TimEvent tevent, ShowSignatureCaptureResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
ShowSignatureCaptureResponse	data

SoftwareUpdateCompleted(TimEvent, UpdateStatus)

Called if an Terminal.softwareUpdateAsync() started request finished.

Declaration

void SoftwareUpdateCompleted(TimEvent tevent, UpdateStatus data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
UpdateStatus	data	Contains update status.

StartCheckoutCompleted(TimEvent)

Called if an Terminal.startCheckoutAsync() started request finished.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void StartCheckoutCompleted(TimEvent tevent)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.

SystemInformationCompleted(TimEvent, SystemInformationResponse)

Called if an Terminal.systemInformationAsync() started request finished.

Declaration

void SystemInformationCompleted(TimEvent tevent, SystemInformationResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
SystemInformationResponse	data	Contains configuration and network information of the terminal.

TerminalStatusChanged(Terminal)

Called if the state of the terminal changed. Retrieve the state using event.getTerminal().getTerminalState().

Declaration

void TerminalStatusChanged(Terminal terminal)

Parameters

Type	Name	Description
Terminal	terminal	Terminal sending the notification.

ThirdPartyAppData(Terminal, ThirdPartyAppPayload)

Called if a ThirdPartyAppData Notification has been received.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void ThirdPartyAppData(Terminal terminal, ThirdPartyAppPayload data)

Parameters

Type	Name	Description
Terminal	terminal
ThirdPartyAppPayload	data

TransactionCompleted(TimEvent, TransactionResponse)

Called if an Terminal.transactionAsync(com.six.timapi.constants.TransactionType, Amount) or Terminal.transactionAsync(com.six.timapi.constants.TransactionType, TransactionRequest) started request finished.

Declaration

void TransactionCompleted(TimEvent tevent, TransactionResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
TransactionResponse	data	Contains transaction result information and print information for the merchant and cardholder.

TransactionInfoRequestCompleted(TimEvent, TransactionInfoRequestResponse)

Called if an Terminal.TransactionInfoRequestAsync() started request finished.

Declaration

void TransactionInfoRequestCompleted(TimEvent tevent, TransactionInfoRequestResponse data)

Parameters

Type	Name	Description
TimEvent	tevent	Contains the terminal sending the event and error information if the request failed.
TransactionInfoRequestResponse	data	Contains all requested receipts up to a maximum number of receipts the EFT Terminal can send. if HasMoreReceipts is True not all receipts could be send by the EFT Terminal. call TransactionInfoRequest again to obtain more receipts.

VasInfo(Terminal, VasCheckoutInformation)

Called if an VAS Information Notification has been received.

Supported only if Guides.VALUE_ADDED_SERVICES is enabled.

Declaration

void VasInfo(Terminal terminal, VasCheckoutInformation vasInfo)

Parameters

Type	Name	Description
Terminal	terminal
VasCheckoutInformation	vasInfo