IDTech iOS/OSX SDK Guide  1.1.090
API reference for UniPay III
IDT_UniPayIII.h
1 //
2 // IDT_UniPayIII.h
3 // IDTech
4 //
5 // Created by Randy Palermo on 10/29/14.
6 // Copyright (c) 2014 IDTech Products. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import "IDTMSRData.h"
11 #import "IDT_Device.h"
12 
14 @protocol IDT_UniPayIII_Delegate <NSObject>
15 @optional
16 -(void) deviceConnected;
17 -(void) deviceDisconnected;
18 - (void) plugStatusChange:(BOOL)deviceInserted;
19 - (void) dataInOutMonitor:(NSData*)data incoming:(BOOL)isIncoming;
21 
26 - (void) swipeMSRData:(IDTMSRData*)cardData;
27 
29 - (void) deviceMessage:(NSString*)message;
30 
32 
33 
34 
48 - (void) lcdDisplay:(int)mode lines:(NSArray*)lines;
49 
62 - (void) emvTransactionData:(IDTEMVData*)emvData errorCode:(int)error;
63 
64 @end
65 
69 @interface IDT_UniPayIII : NSObject<IDT_Device_Delegate>{
70  id<IDT_UniPayIII_Delegate> delegate;
71 }
72 
73 @property(strong) id<IDT_UniPayIII_Delegate> delegate;
74 
75 
76 
84 +(NSString*) SDK_version;
85 
94 
99 -(void) close;
100 
108 -(void) device_connectToUSB;
109 
110 
111 
118 -(RETURN_CODE) ctls_cancelTransaction;
119 
132 -(RETURN_CODE) ctls_startTransaction;
133 
143 -(RETURN_CODE) device_cancelConnectToAudioReader;
152 -(RETURN_CODE) device_connectToAudioReader;
153 
154 
173 -(RETURN_CODE) device_getFirmwareVersion:(NSString**)response;
174 
175 
195 -(bool) device_enableBLEDeviceSearch:(IDT_DEVICE_Types)type identifier:(NSUUID*)identifier;
196 
197 
208 
216 -(NSUUID*) device_connectedBLEDevice;
217 
229 
230 
231 
244 -(NSString *) device_getResponseCodeString: (int) errorCode;
245 
261 -(bool) device_isConnected:(IDT_DEVICE_Types)device;
262 
276 -(RETURN_CODE) device_sendIDGCommand:(unsigned char)command subCommand:(unsigned char)subCommand data:(NSData*)data response:(NSData**)response;
277 
298 -(RETURN_CODE) device_setAudioVolume:(float)val;
299 
319 -(RETURN_CODE) device_setPassThrough:(BOOL)enablePassThrough;
320 
338 -(RETURN_CODE) device_startRKI;
339 
365 -(RETURN_CODE) emv_authenticateTransaction:(NSData*)tags;
382 -(RETURN_CODE) emv_callbackResponseLCD:(int)mode selection:(unsigned char) selection;
383 
384 
385 
428 -(RETURN_CODE) emv_completeOnlineEMVTransaction:(BOOL)isSuccess hostResponseTags:(NSData*)tags;
429 
430 
431 
440 -(void) emv_disableAutoAuthenticateTransaction:(BOOL)disable;
441 
442 
443 
462 -(RETURN_CODE) emv_getEMVL2Version:(NSString**)response;
463 
483 -(RETURN_CODE) emv_removeApplicationData:(NSString*)AID;
484 
505 -(RETURN_CODE) emv_removeCAPK:(NSString*)rid index:(NSString*)index ;
506 
507 
508 
509 
527 -(RETURN_CODE) emv_removeCRLList;
528 
529 
548 -(RETURN_CODE) emv_removeTerminalData;
549 
569 -(RETURN_CODE) emv_retrieveAIDList:(NSArray**)response;
570 
571 
600 -(RETURN_CODE) emv_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)responseAID;
601 
624 -(RETURN_CODE) emv_retrieveCAPK:(NSString*)rid index:(NSString*)index response:(CAKey**)response;
625 
626 
658 -(RETURN_CODE) emv_retrieveCAPKFile:(NSString*)rid index:(NSString*)index response:(NSData**)response;
659 
679 -(RETURN_CODE) emv_retrieveCAPKList:(NSArray**)response;
680 
681 
682 
702 -(RETURN_CODE) emv_retrieveCRLList:(NSMutableArray**)response;
703 
704 
705 
706 
707 
729 -(RETURN_CODE) emv_retrieveTerminalData:(NSDictionary**)responseData;
730 
752 -(RETURN_CODE) emv_retrieveTransactionResult:(NSData*)tags retrievedTags:(NSDictionary**)retrievedTags;
753 
800 -(RETURN_CODE) emv_setApplicationData:(NSString*)aidName configData:(NSDictionary*)data;
801 
821 -(RETURN_CODE) emv_setCAPK:(CAKey)key;
822 
840 -(RETURN_CODE) emv_setCAPKFile:(NSData*)file;
841 
865 -(RETURN_CODE) emv_setCRLEntries:(NSData*)data;
866 
867 
868 
869 
915 -(RETURN_CODE) emv_setTerminalData:(NSDictionary*)data;
916 
917 
918 
919 
920 
947 -(RETURN_CODE) emv_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
948 
949 
960 -(RETURN_CODE) config_getSerialNumber:(NSString**)response;
961 
976 -(RETURN_CODE) icc_exchangeAPDU:(NSData*)dataAPDU response:(APDUResponse**)response;
1007 -(RETURN_CODE) icc_getICCReaderStatus:(ICCReaderStatus**)readerStatus;
1008 
1024 -(RETURN_CODE) icc_powerOnICC:(NSData**)response;
1025 
1026 
1027 
1042 -(RETURN_CODE) icc_powerOffICC:(NSString**)error;
1043 
1054 -(RETURN_CODE) msr_cancelMSRSwipe;
1055 
1068 -(RETURN_CODE) msr_startMSRSwipe;
1069 
1073 -(bool) isConnected;
1074 
1075 @end
IDT_UniPayIII * sharedController()
RETURN_CODE msr_startMSRSwipe()
void deviceConnected()
Fires when device connects. If a connection is established before the delegate is established (no del...
RETURN_CODE device_startRKI()
Definition: IDTMSRData.h:21
RETURN_CODE device_cancelConnectToAudioReader()
Definition: IDT_UniPayIII.h:69
RETURN_CODE ctls_startTransaction()
RETURN_CODE emv_removeCRLList()
Definition: APDUResponse.h:14
void deviceDisconnected()
Fires when device disconnects.
Definition: IDTCommon.h:13
Definition: IDTCommon.h:42
NSString * SDK_version()
BOOL device_isAudioReaderConnected()
RETURN_CODE device_connectToAudioReader()
id< IDT_UniPayIII_Delegate > delegate
Definition: IDT_UniPayIII.h:70
RETURN_CODE emv_removeTerminalData()
void device_connectToUSB()
NSUUID * device_connectedBLEDevice()
bool device_disableBLEDeviceSearch()
Definition: IDT_UniPayIII.h:14
RETURN_CODE ctls_cancelTransaction()
RETURN_CODE msr_cancelMSRSwipe()
Definition: IDTEMVData.h:16