IDTech iOS Framework Guide  1.1.088
API reference for UniPay
<IDT_UniPay_Delegate> Protocol Reference

#import <IDT_UniPay.h>

Inheritance diagram for <IDT_UniPay_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) - eventFunctionICC:
 

Detailed Description

Protocol methods established for IDT_UniPay 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) eventFunctionICC: (Byte)  nICC_Attached
optional

UniPay ICC Event This function will be called when an ICC is attached or detached from reader. Applies to UniPay only

Parameters
nICC_AttachedCan be one of the following values:
  • 0x01: ICC attached while reader is idle
  • 0x00: ICC detached while reader is idle
  • 0x11: ICC attached while reader is in MSR mode
  • 0x10: After ICC Powered On, ICC Card Removal,Power off ICC
-(void) eventFunctionICC: (Byte) nICC_Attached
{
switch (nICC_Attached) {
case 0x01:
case 0x11:
{
LOGI(@"ICC event: ICC attached.");
}
break;
case 0x00:
case 0x10:
{
LOGI(@"ICC event: ICC detached.");
}
break;
}
}
- (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: