IDTech iOS SDK Guide  1.1.113
API reference for NEO2
IDT_VP3600.h
1 //
2 // IDT_VP3600.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_VP3600_Delegate <NSObject>
15 @optional
16 -(void) deviceConnected;
17 -(void) deviceDisconnected;
18 - (void) dataInOutMonitor:(NSData*)data incoming:(BOOL)isIncoming;
19 
24 - (void) swipeMSRData:(IDTMSRData*)cardData;
25 
27 - (void) deviceMessage:(NSString*)message;
28 
30 
55 - (void) pinpadData:(NSData*)value keySN:(NSData*)KSN event:(EVENT_PINPAD_Types)event;
56 
70 - (void) lcdDisplay:(int)mode lines:(NSArray*)lines;
71 
72 
73 
86 - (void) emvTransactionData:(IDTEMVData*)emvData errorCode:(int)error;
87 
88 @end
89 
93 @interface IDT_VP3600 : NSObject<IDT_Device_Delegate>{
94  id<IDT_VP3600_Delegate> delegate;
95 }
96 
97 @property(strong) id<IDT_VP3600_Delegate> delegate;
98 
99 
100 
108 +(NSString*) SDK_version;
109 
118 
123 -(void) close;
124 
125 
126 
133 -(RETURN_CODE) ctls_cancelTransaction;
134 
135 
136 
143 -(RETURN_CODE) emv_cancelTransaction;
144 
145 
146 
153 -(RETURN_CODE) device_cancelTransaction;
154 
155 
168 -(RETURN_CODE) ctls_getConfigurationGroup:(int)group response:(NSDictionary**)response;
169 
170 
171 
172 
182 -(RETURN_CODE) ctls_removeAllCAPK;
183 
194 -(RETURN_CODE) ctls_removeApplicationData:(NSString*)AID;
195 
206 -(RETURN_CODE) ctls_removeCAPK:(NSData*)capk;
207 
218 -(RETURN_CODE) ctls_removeConfigurationGroup:(int)group;
219 
220 
231 -(RETURN_CODE) ctls_retrieveAIDList:(NSArray**)response;
232 
243 -(RETURN_CODE) ctls_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)response;
244 
262 -(RETURN_CODE) ctls_retrieveCAPK:(NSData*)capk key:(NSData**)key;
263 
264 
274 -(RETURN_CODE) ctls_retrieveCAPKList:(NSArray**)keys;
275 
288 -(RETURN_CODE) ctls_retrieveTerminalData:(NSData**)tlv;
289 
305 -(RETURN_CODE) ctls_setApplicationData:(NSData*)tlv;
306 
324 -(RETURN_CODE) ctls_setCAPK:(NSData*)key;
325 
326 
340 -(RETURN_CODE) ctls_setConfigurationGroup:(NSData*)tlv;
341 
342 
356 -(RETURN_CODE) ctls_setTerminalData:(NSData*)tlv;
357 
358 
359 
360 
419 -(RETURN_CODE) ctls_startTransaction:(double)amount type:(int)type timeout:(int)timeout tags:(NSMutableDictionary *)tags;
420 
421 
422 
441 -(RETURN_CODE) device_getFirmwareVersion:(NSString**)response;
442 
443 
462 -(bool) device_enableBLEDeviceSearch:(NSUUID*)identifier;
463 
464 
465 
473 -(NSString*) device_getBLEFriendlyName;
474 
475 
483 -(void) device_setBLEFriendlyName:(NSString*)friendlyName;
484 
485 
496 
504 -(NSUUID*) device_connectedBLEDevice;
505 
506 
507 
508 
518 -(RETURN_CODE) device_getAutoPollTransactionResults:(IDTEMVData**)result;
519 
532 -(NSString *) device_getResponseCodeString: (int) errorCode;
533 
549 -(bool) device_isConnected:(IDT_DEVICE_Types)device;
550 
564 -(RETURN_CODE) device_sendIDGCommand:(unsigned char)command subCommand:(unsigned char)subCommand data:(NSData*)data response:(NSData**)response;
565 
566 
567 
587 -(RETURN_CODE) device_setPassThrough:(BOOL)enablePassThrough;
588 
589 
590 
601 -(RETURN_CODE) device_setBurstMode:(int) mode;
602 
603 
614 -(RETURN_CODE) device_setPollMode:(int) mode;
615 
616 
642 -(RETURN_CODE) emv_authenticateTransaction:(NSData*)tags;
659 -(RETURN_CODE) emv_callbackResponseLCD:(int)mode selection:(unsigned char) selection;
660 
677 -(RETURN_CODE) emv_callbackResponsePIN:(EMV_PIN_MODE_Types)mode KSN:(NSData*)KSN PIN:(NSData*)PIN;
678 
721 -(RETURN_CODE) emv_completeOnlineEMVTransaction:(BOOL)isSuccess hostResponseTags:(NSData*)tags;
722 
723 
724 
733 -(void) emv_disableAutoAuthenticateTransaction:(BOOL)disable;
734 
735 
736 
755 -(RETURN_CODE) emv_getEMVL2Version:(NSString**)response;
756 
776 -(RETURN_CODE) emv_removeApplicationData:(NSString*)AID;
777 
798 -(RETURN_CODE) emv_removeCAPK:(NSString*)rid index:(NSString*)index ;
799 
811 -(RETURN_CODE) emv_setTerminalMajorConfiguration:(int)configuration;
812 
824 -(RETURN_CODE) emv_getTerminalMajorConfiguration:(NSUInteger**)configuration;
825 
826 
844 -(RETURN_CODE) emv_removeCRLList;
845 
846 
865 -(RETURN_CODE) emv_removeTerminalData;
866 
886 -(RETURN_CODE) emv_retrieveAIDList:(NSArray**)response;
887 
888 
917 -(RETURN_CODE) emv_retrieveApplicationData:(NSString*)AID response:(NSDictionary**)responseAID;
918 
941 -(RETURN_CODE) emv_retrieveCAPK:(NSString*)rid index:(NSString*)index response:(CAKey**)response;
942 
943 
975 -(RETURN_CODE) emv_retrieveCAPKFile:(NSString*)rid index:(NSString*)index response:(NSData**)response;
976 
996 -(RETURN_CODE) emv_retrieveCAPKList:(NSArray**)response;
997 
998 
999 
1019 -(RETURN_CODE) emv_retrieveCRLList:(NSMutableArray**)response;
1020 
1021 
1022 
1023 
1024 
1046 -(RETURN_CODE) emv_retrieveTerminalData:(NSDictionary**)responseData;
1047 
1069 -(RETURN_CODE) emv_retrieveTransactionResult:(NSData*)tags retrievedTags:(NSDictionary**)retrievedTags;
1070 
1117 -(RETURN_CODE) emv_setApplicationData:(NSString*)aidName configData:(NSDictionary*)data;
1118 
1138 -(RETURN_CODE) emv_setCAPK:(CAKey)key;
1139 
1157 -(RETURN_CODE) emv_setCAPKFile:(NSData*)file;
1158 
1182 -(RETURN_CODE) emv_setCRLEntries:(NSData*)data;
1183 
1184 
1185 
1186 
1232 -(RETURN_CODE) emv_setTerminalData:(NSDictionary*)data;
1233 
1234 
1235 
1236 
1237 
1275 -(RETURN_CODE) emv_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
1276 
1277 
1288 -(RETURN_CODE) config_getSerialNumber:(NSString**)response;
1289 
1304 -(RETURN_CODE) icc_exchangeAPDU:(NSData*)dataAPDU response:(APDUResponse**)response;
1335 -(RETURN_CODE) icc_getICCReaderStatus:(ICCReaderStatus**)readerStatus;
1336 
1352 -(RETURN_CODE) icc_powerOnICC:(NSData**)response;
1353 
1354 
1355 
1370 -(RETURN_CODE) icc_powerOffICC:(NSString**)error;
1371 
1384 -(RETURN_CODE) msr_cancelMSRSwipe;
1385 
1398 -(RETURN_CODE) msr_startMSRSwipe;
1399 
1403 -(bool) isConnected;
1404 
1405 
1406 
1444 -(RETURN_CODE) device_startTransaction:(double)amount amtOther:(double)amtOther type:(int)type timeout:(int)timeout tags:(NSData*)tags forceOnline:(BOOL)forceOnline fallback:(BOOL)fallback;
1445 
1456 -(RETURN_CODE) pin_captureFunctionKey;
1457 
1467 -(RETURN_CODE) pin_cancelPin;
1468 
1492 -(RETURN_CODE) pin_capturePin:(int)type PAN:(NSString*)PAN minPIN:(int)minPIN maxPIN:(int)maxPIN message:(NSString*)message;
1493 
1494 
1495 
1508 -(RETURN_CODE) felica_authentication:(NSData*)key;
1509 
1510 
1511 
1524 -(RETURN_CODE) felica_readWithMac:(NSData*)blockList blocks:(NSData**)blocks;
1525 
1526 
1539 -(RETURN_CODE) felica_writeWithMac:(int)blockNumber data:(NSData*)data;
1540 
1541 
1555 -(RETURN_CODE) felica_read:(NSData*)serviceCode blockList:(NSData*)blockList blocks:(NSData**)blocks;
1556 
1557 
1572 -(RETURN_CODE) felica_write:(NSData*)serviceCode blockList:(NSData*)blockList data:(NSData*)data statusFlag:(NSData**)statusFlag;
1573 
1586 -(RETURN_CODE) felica_poll:(NSData*)systemCode response:(NSData**)response;
1587 
1588 
1601 -(RETURN_CODE) felica_requestService:(NSData*)nodeCode response:(NSData**)response;
1602 
1621 -(RETURN_CODE) pin_captureAmountInput:(int)minPIN maxPIN:(int)maxPIN message:(NSString*)message signature:(NSData*)signature;
1622 
1642 -(RETURN_CODE) pin_captureNumericInput:(bool)mask minPIN:(int)minPIN maxPIN:(int)maxPIN message:(NSString*)message signature:(NSData*)signature;
1643 
1644 
1645 @end
RETURN_CODE ctls_cancelTransaction()
void deviceConnected()
Fires when device connects. If a connection is established before the delegate is established (no del...
NSString * SDK_version()
IDT_VP3600 * sharedController()
NSString * device_getBLEFriendlyName()
void deviceDisconnected()
Fires when device disconnects.
RETURN_CODE emv_removeTerminalData()
Definition: IDTMSRData.h:21
RETURN_CODE msr_cancelMSRSwipe()
bool device_disableBLEDeviceSearch()
RETURN_CODE ctls_removeAllCAPK()
Definition: APDUResponse.h:14
bool isConnected()
Definition: IDTCommon.h:13
RETURN_CODE emv_cancelTransaction()
Definition: IDTCommon.h:42
RETURN_CODE device_cancelTransaction()
RETURN_CODE pin_cancelPin()
RETURN_CODE msr_startMSRSwipe()
id< IDT_VP3600_Delegate > delegate
Definition: IDT_VP3600.h:94
RETURN_CODE emv_removeCRLList()
RETURN_CODE pin_captureFunctionKey()
NSUUID * device_connectedBLEDevice()
Definition: IDT_VP3600.h:14
Definition: IDT_VP3600.h:93
Definition: IDTEMVData.h:16