IDTech iOS SDK Guide  1.1.166.045
API reference for NEO2
IDTMSRData Class Reference

#import <IDTMSRData.h>

Inheritance diagram for IDTMSRData:

Instance Methods

(void) - clear
 

Class Methods

(IDTMSRData *) + sharedController
 

Properties

KEY_VARIANT_TYPE msr_keyVariantType
 
EVENT_MSR_Types event
 
CAPTURE_ENCODE_TYPE captureEncodeType
 
CAPTURE_ENCRYPT_TYPE captureEncryptType
 
CAPTURE_CARD_TYPE captureCardType
 
NSData * mac
 mac
 
NSData * macKSN
 macKSN
 
NSData * cardData
 Complete unparsed swipe data as received from MSR.
 
NSString * kbOutput
 Contains output converted to KB format.
 
NSString * track1
 Track 1 masked if encryption enabled or cleartext if encryption disabled.
 
NSString * track2
 Track 2 masked if encryption enabled or cleartext if encryption disabled.
 
NSString * track3
 Track 3 masked if encryption enabled or cleartext if encryption disabled.
 
int track1Length
 Length of track 1 masked/clear text data.
 
int track2Length
 Length of track 2 masked/clear text data.
 
int track3Length
 Length of track 3 masked/clear text data.
 
NSData * rawData
 rawData
 
NSData * msr_extendedField
 MSR Extended Field.
 
NSData * encTrack1
 Track 1 encoded data OR all encoded track data if encryption method combines all tracks into single blob.
 
NSData * encTrack2
 Track 2 encoded.
 
NSData * encTrack3
 Track 3 encoded.
 
NSData * hashTrack1
 Sha-256 hash of Track 1 encoded data.
 
NSData * hashTrack2
 Sha-256 hash of Track 2 encoded data.
 
NSData * hashTrack3
 Sha-256 hash of Track 3 encoded data.
 
NSString * RSN
 Reader Serial Number.
 
NSData * KSN
 Key Serial Number.
 
NSData * sessionID
 Session ID - Security level 4 only.
 
unsigned char readStatus
 
int errorCode
 Contains error code when data is not returned.
 
bool iccPresent
 Card contains ICC.
 
NSDictionary * unencryptedTags
 Unencrypted card data provided via TLV.
 
NSDictionary * encryptedTags
 Encrypted card data provided via TLV.
 
NSDictionary * maskedTags
 Masked card data provided via TLV.
 

Detailed Description

Encapsulating data class for MSR data capture

Method Documentation

- (void) clear

clears all IDTMSRData properties

+ (IDTMSRData *) sharedController

Singleton instance of IDTMSRData

Property Documentation

- (CAPTURE_ENCODE_TYPE) captureEncodeType
readwriteatomic

Encode Type of captured MSR Data.

Uses enumeration CAPTURE_ENCODE_TYPE:

typedef enum{
CAPTURE_ENCODE_TYPE_ISOABA=0,
CAPTURE_ENCODE_TYPE_AAMVA=1,
CAPTURE_ENCODE_TYPE_Other=3,
CAPTURE_ENCODE_TYPE_Raw=4
} CAPTURE_ENCODE_TYPE;
- (CAPTURE_ENCRYPT_TYPE) captureEncryptType
readwriteatomic

Encrypt Type of captured MSR Data.

Uses enumeration CAPTURE_ENCODE_TYPE:

typedef enum{
CAPTURE_ENCRYPT_TYPE_TDES=0,
CAPTURE_ENCRYPT_TYPE_AES=1
} CAPTURE_ENCRYPT_TYPE;
- (EVENT_MSR_Types) event
readwriteatomic

Event type. Uses enumeration EVENT_MSR_Types

typedef enum{
EVENT_MSR_UNKNOWN = 31,
EVENT_MSR_CARD_DATA,
EVENT_MSR_CANCEL_KEY,
EVENT_MSR_BACKSPACE_KEY,
EVENT_MSR_ENTER_KEY,
EVENT_MSR_DATA_ERROR,
EVENT_MSR_ICC_START,
EVENT_BTPAY_CARD_DATA,
EVENT_UNIPAYII_EMV_NO_ICC_MSR_DATA,
EVENT_UNIPAYII_EMV_FALLBACK_DATA,
EVENT_UNIPAY_KEYLOADING,
EVENT_MSR_TIMEOUT
}EVENT_MSR_Types;
- (unsigned char) readStatus
readwriteatomic

Track Read Status

  • Bit 0: 1=Track 1 decode success, 0=Track 1 decode fail
  • Bit 1: 1=Track 2 decode success, 0=Track 2 decode fail)
  • Bit 2: 1=Track 3 decode success, 0=Track 3 decode fail)
  • Bit 3: 1=Track 1 sampling data exists, 0=Track 1 sampling data does not exist
  • Bit 4: 1=Track 2 sampling data exists, 0=Track 2 sampling data does not exist
  • Bit 5: 1=Track 3 sampling data exists, 0=Track 3 sampling data does not exist
  • Bit 6: reserved for future use
  • Bit 7: reserved for future use

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