IDTech iOS/OSX SDK Guide  1.1.052
API reference for BTPay 200
 All Data Structures Functions Variables Properties Pages
IDT_UniMag Class Reference
Inheritance diagram for IDT_UniMag:

Instance Methods

(RETURN_CODE) - device_sendUniMagCommand:
 
(RETURN_CODE) - config_getSerialNumber:
 
(NSString *) - device_getResponseCodeString:
 
(RETURN_CODE) - device_connectToAudioReader
 
(RETURN_CODE) - msr_cancelMSRSwipe
 
(RETURN_CODE) - msr_startMSRSwipe
 
(RETURN_CODE) - msr_setSwipeEncryption:
 
(RETURN_CODE) - device_setPrePANClearDigits:
 
(RETURN_CODE) - msr_getNextKSN:
 
(RETURN_CODE) - msr_setSwipeForcedEncryptionOption:
 
(bool) - isConnected
 

Class Methods

(NSString *) + SDK_version
 
(IDT_UniMag *) + sharedController
 

Properties

id< IDT_UniMag_Delegatedelegate
 

Method Documentation

- (RETURN_CODE) config_getSerialNumber: (NSString **)  response

Polls device for Serial Number

Parameters
responseReturns Serial Number
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) device_connectToAudioReader

Connect To Audio Reader

Return values
RETURN_CODEAttemps to recognize and connect to an IDTech MSR device connected via the audio port.
- (NSString *) device_getResponseCodeString: (int)  errorCode

Get Response Code String

Interpret a IDT_UniMag response code and return string description.

Parameters
errorCodeError code, range 0x0000 - 0xFFFF, example 0x0300
Return values
Verboseerror description
- (RETURN_CODE) device_sendUniMagCommand: (UNIMAG_COMMAND_Types)  command

Send UniMag Command

Parameters
commandA command to execute from UNIMAG_COMMAND_Types enumeration
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) device_setPrePANClearDigits: (int)  clearDigits

Set PrePAN Clear Digits

Sets the number of digits to show in clear text at the beginning of PAN

Parameters
clearDigitsAmount of characters to display cleartext at beginning of PAN. Valid range 0-6. Default value 4.
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:)
- (bool) isConnected

Device Connected

Return values
isConnectedBoolean indicated if UniMag is connected
- (RETURN_CODE) msr_cancelMSRSwipe

Disable MSR Swipe

Cancels MSR swipe request.

Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) msr_getNextKSN: (NSData **)  response

Polls device for next KSN

Parameters
responseReturns next KSN
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) msr_setSwipeEncryption: (int)  encryption

Set Swipe Data Encryption

Sets the swipe encryption method

Parameters
encryption1 = TDES, 2 = AES
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) msr_setSwipeForcedEncryptionOption: (BOOL)  forceON

Set Swipe Force Encryption

Sets the swipe force encryption options

Parameters
forceONTRUE = Force Encryption ON, FALSE = Force Encryption OFF
Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
- (RETURN_CODE) msr_startMSRSwipe

Enable MSR Swipe

Enables MSR, waiting for swipe to occur. Allows track selection. Returns IDTMSRData instance to deviceDelegate::swipeMSRData:()

Return values
RETURN_CODEReturn codes listed as typedef enum in IDTCommon:RETURN_CODE. Values can be parsed with device_getResponseCodeString:
+ (NSString*) SDK_version

SDK Version

  • All Devices

Returns the current version of IDTech.framework

Return values
Frameworkversion
+ (IDT_UniMag*) sharedController

Singleton Instance

  • All Devices

Establishes an singleton instance of IDT_UniMag class.

Return values
Instanceof IDT_UniMag

Property Documentation

- (id< IDT_UniMag_Delegate >) delegate
readwriteatomicstrong

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