IDTech iOS/OSX SDK Guide  1.1.084
API reference for UniPay 1.5
<IDT_UniPayI_V_Delegate> Protocol Reference

#import <IDT_UniPayI_V.h>

Inheritance diagram for <IDT_UniPayI_V_Delegate>:

Instance Methods

(void) - deviceConnected
 Fires when device connects. If a connection is established before the delegate is established (no delegate to send initial connection notification to), this method will fire upon establishing the delegate.
 
(void) - deviceDisconnected
 Fires when device disconnects.
 
(void) - plugStatusChange:
 
(void) - dataInOutMonitor:incoming:
 
(void) - swipeMSRData:
 
(void) - deviceMessage:
 
(void) - lcdDisplay:lines:
 
(void) - emvTransactionData:errorCode:
 

Detailed Description

Protocol methods established for IDT_UniPayI_V class

Method Documentation

- (void) dataInOutMonitor: (NSData *)  data
incoming: (BOOL)  isIncoming 
optional

All incoming/outgoing data going to the device can be monitored through this delegate.

Parameters
dataThe serial data represented as a NSData object
isIncomingThe direction of the data
  • TRUE specifies data being received from the device,
  • FALSE indicates data being sent to the device.
- (void) deviceMessage: (NSString *)  message
optional

Receives messages from the framework

Parameters
messageString message transmitted by framework
- (void) emvTransactionData: (IDTEMVData *)  emvData
errorCode: (int)  error 
optional

EMV Transaction Data

This protocol will receive results from IDT_Device::startEMVTransaction:otherAmount:timeout:cashback:additionalTags:()

Parameters
emvDataEMV Results Data. Result code, card type, encryption type, masked tags, encrypted tags, unencrypted tags and KSN
errorThe error code as defined in the errors.h file
- (void) lcdDisplay: (int)  mode
lines: (NSArray *)  lines 
optional

LCD Display Request During an EMV transaction, this delegate will receive data to clear virtual LCD display, display messages, display menu, or display language. Applies to UniPay III

Parameters
modeLCD Display Mode:
  • 0x01: Menu Display. A selection must be made to resume the transaction
  • 0x02: Normal Display get function key. A function must be selected to resume the transaction
  • 0x03: Display without input. Message is displayed without pausing the transaction
  • 0x04: List of languages are presented for selection. A selection must be made to resume the transaction
  • 0x10: Clear Screen. Command to clear the LCD screen
- (void) plugStatusChange: (BOOL)  deviceInserted
optional

Monitors the headphone jack for device insertion/removal.

Parameters
deviceInsertedTRUE = device inserted, FALSE = device removed
- (void) swipeMSRData: (IDTMSRData *)  cardData
optional

Receives card data from MSR swipe.

Parameters
cardDataCaptured card data from MSR swipe

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