1 of 26

Enumerations - B - E

BarCodeFormat

This enum refers to the type of barcodes to display.

Enum

Description

BLOB

Data is binary format

COMMAND

Data is a command in binary format

This enum refers to the type of barcodes to display.

Enum

Description

This enum refers to the type of customer information to capture.

Enum

Description

This enum refers to the readiness of the SDK to communicate with the device. This is not the physical attachment to a host system.

Enum

Description

This enum refers to the communication interface type of MagTek reader which the SDK will control.

Enum

Description

This enum is reserved for future use.

Enum

Description

This enum refers to a change in the device status.

Enum

Description

This enum refers to a featured supported by the device.

Enum

Description

This enum refers to the type of MagTek reader which the SDK will control.

Enum

Description

This enum refers to the type of connection error.

Enum

Description

This enum refers to the type of event triggered by the device.

Enum

Description

ISystemStatusCallback Delegates

This interface invokes callback functions to receive data and/or a detailed response. To register for the event(s), call the setSystemStatusCallback() function with the name of a class that implements the ISystemStatusCallback interface.

OnError

This event is called when an error occurs with the connection with the MQTT broker.

Prototype

void OnError(
    ErrorType error, 
    String details);

Parameters

Parameter

Description

Return Value: None

CoreAPI

Use the CoreAPI to create an IDevice. IDevice is the bases for the MagTek Universal SDK.

If accessing a device specific API outside of MagTek Universal SDK, use the various functions in this section to create an instance of that device’s API. Once a device specific API is referenced, the associated library will need to be added into the application’s development project.

createCMSDevice

This function creates an instance of a CMS type of device.

The API’s of MagTek Universal SDK do not apply. See D998200160 MagTek Common Message Structure (MTCMS) for the MTCMS API.

MTDevice CoreAPI.createCMSDevice(Context context, Handler handler);

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
handler — An instance of android.os.Handler to allow SDK access to application-specific message queues.

Return Value:

Returns an MTDevice.

This function creates an instance of IDevice. All API’s of MagTek Universal SDK can but utilized from IDevice.

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
deviceType — Enumerated device type.
connectionType — Enumerated connection type.

Return Value:

Returns an IDevice.

This function creates an instance of an MMS type of device, DynaFlex Family.

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
deviceAdapter — Callback interface for MMS device messages.

Return Value:

Returns an MMXDevice.

This function creates an instance of an MTPPSCRA type of device.

The API’s of MagTek Universal SDK do not apply. See D998200078 IPAD, DynaPro, DynaPro Go, and DynaPro Mini PIN Encryption Devices Programmer’s Reference for the MTPPSCRA API.

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
handler — An instance of android.os.Handler to allow SDK access to application-specific message queues.

Return Value:

Returns an MTPPSCRA.

This function creates an instance of a MTSCRA type of device.

The API’s of MagTek Universal SDK do not apply. See D99875723 uDynamo, Dynamag, DynaMAX, eDynamo, mDynamo, Insert, DynaWave, iDynamo 6 for the MTSCRA API.

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
handler — An instance of android.os.Handler to allow SDK access to application-specific message queues.

Return Value:

Returns an MTSCRA.

This function returns a list of IDevice. IDevice is the base for utilizing the MagTek Universal SDK interface.

Parameter

context — An instance of android.content.Context to allow SDK access to application-specific resources.
deviceType — An enum for the type of MagTek readers which the SDK will control.
deviceTypes — An enum list for the type of MagTek readers which the SDK will control.

Return Value:

Returns a list of IDevice

This function returns the API version.

Return Value:

Returns an integer representing the API version.

This function sets the MQTT (Message Queuing Telemetry Transport) broker information. Call prior to device discovery.

Parameter

uri — URI included the port. Support URIs:
1. TCP: test.mosquitto.org, test.mosquitto.org:1883, mqtt://test.mosquitto.org:1883, mqtt://broker.emqx.io:1883

Return Value: None

This function sets the MQTT client ID to establish a connection.

Parameter

clientID — Client ID. If not set, the default value is [HostName]-[RandomUUID]

Return Value: None

This function sets the MQTT certificate information.

Parameter

certificateInfo — If client certificate is required when initiating a connection to the MQTT broker, this shall be used to establish the connection. If not set, the default value is NULL.

Return Value: None

This function sets the MQTTDeviceDiscoveryTimeout value.

Parameter

timeout — Time out in milliseconds. Default value = 5000 if not set. A call to getDeviceList() does not return the list until this time has expired.

Return Value: None

This function sets the MQTT callback interface instance.

After connecting to the MQTT broker, the MQTT Device Status Monitoring subscribes to

"<MQTTSubscribeTopic>/#" . The wildcard "/#" is automatically appended.

Example:

When a device status updates to “connected” or “disconnected”, OnConnected() and OnDisconnected() are invoked respectively.

This method can be called whether or not there is an active connection to an MQTT device.

Devices reporting with "/Status/connected" are added to the device list as follows:

Parameter

callback — Name of a class or structure that implements the IMQTTDeviceStatusCallback interface events. Call after calling getDeviceList().

Return Value: None

This function sets the base value for MQTTPublishTopic. When connected to the MQTT broker, the composed topic is in the format:

Example:

Base topic = “MagTek/Device/DynaFlexIIPED/”
Full topic = “MagTek/Device/DynaFlexIIPED/B51E72D/MMSMessage”

Parameter

topic — Base topic for which to publish messages. Full topic is composed by the SDK.

Return Value: None

This function sets the MQTTQoS value.

Parameter

qos — The quality of service level for publishing messages. Range:
- 0 = At most once (default)
- 1 = At least once
- 2 = Exactly once

Return Value: None

This function sets the base value for MQTTSubscribeTopic. When connected to the device, the composed topic is in the format:

“<basetopic>/<DeviceID>/MMSMessage”.

Example:

Base topic = “MagTek/Server/DynaFlexIIPED/”
Full topic = “MagTek/Server/DynaFlexIIPED/B51E72D/MMSMessage”

Parameter

topic — Base topic for which to subscribe for messages.

Return Value: None

This function stops the MQTT device status monitoring process. If called when already running, the process shall be stopped immediately. This method can be called whether or not there is an active connection to an MQTT device.

Return Value: None

This function sets the SystemStatusCallback global value.

Parameter

callback — Name of a class or structure that implements the ISystemStatusCallback interface event. Call before starting any MQTT communication. When there is an error, the interface’s OnError() event is invoked.

Return Value: None

TCP (Authenticated): test.mosquitto.org:1884, mqtt://test.mosquitto.org:1884

IDevice CoreAPI.createDevice( 
    Context context, 
    DeviceType deviceType,
    ConnectionType connectionType, 
    String address,
String model, String name, String serial,
CertificateInfo certificateInfo);

List<IDevice> CoreAPI.getDeviceList( 
    Context context,
    IDeviceListCallback deviceListCallback);

List<IDevice> CoreAPI.getDeviceList( 
    Context context,
    DeviceType deviceType, 
    IDeviceListCallback deviceListCallback);

List<IDevice> CoreAPI.getDeviceList( 
    Context context, 
    List<DeviceType> deviceTypes,
    IDeviceListCallback deviceListCallback);

// Access MMS with Universal SDK using createDevice()

IDevice mtmms = CoreAPI.createDevice( 
    context,
    DeviceType.MMS, 
    ConnectionType.USB, "",
    "",
    "DynaFlex", 
    "");
mtmms.requestSignature();

import com.magtek.mobile.android.mtusdk.*;


// Extend the main window to receive events.
public class MainWindow implements IEventSubscriber, 
IConfigurationCallback
{

// Establish a device from CoreAPI. List<IDevice> deviceList = CoreAPI.getDeviceList(
    context, 
    deviceListCallbac);
IDevice device = deviceList[0];

/* For a list of a single device type. DeviceType deviceType = DeviceType.MMS;
List<IDevice> deviceList = CoreAPI.getDeviceList( 
    context,
    deviceType deviceListCallback);
IDevice device = deviceList[0];
*/

/* For a list of multiple device types. 
List<DeviceType> deviceTypes = null; 
deviceTypes.Add(DeviceType.MMS); 
deviceTypes.Add(DeviceType.CMS);
List<IDevice> deviceList = CoreAPI.getDeviceList( 
    context,
    deviceTypes, 
    deviceListCallback);
IDevice device = deviceList[0];
*/

/* Suscribe to events sent from the device.
These would be but not limited to: card inserted, card removed, connection state...

Set MainWindow to receive the events. */ 
boolean return = device.unsubscribeAll(this);
boolean return = device.subscribeAll(this);

/* To handle events from some other class. 
EventsVector eventsVector = new EventsVector() 
boolean return = device.unsubscribeAll(eventsVector); 
boolean return = device.subscribeAll(eventsVector);
*/

// Assign parameters for the transaction.
List<PaymentMethod> paymentMethod = new List<PaymentMethod>(); 
paymentMethod.Add(PaymentMethod.MSR); 
paymentMethod.Add(PaymentMethod.Contact); 
paymentMethod.Add(PaymentMethod.Contactless);

Transaction transaction = new Transaction(); 
transaction.setAmount(“1.00”); 
transaction.setCashBack(“0.00”); 
transaction.setEMVOnly(true); 
transaction.setPaymentMethods(paymentMethod); 
transaction.setQuickChip(false);

// Start transaction.
boolean result = device.startTransaction(transaction);

PersonalInfoEntry PersonalInfoEntryBuilder.GetPersonalInfoEntry( 
DeviceType deviceType, 
byte[] dataBytes);

new PersonalInfoEntry( 
    byte[] data, 
    CaptureType dataType, 
    bool encrypted,
    ); 

new PersonalInfoEntry( 
        byte[] data, 
        CaptureType dataType, 
        bool encrypted, 
        byte encryptionType, 
        byte[] ksn
        );

case TransactionStatus:
// Parse for the transaction status code and detail. 
TransactionStatus status = 
TransactionStatusBuilder.GetStatusCode(data.StringValue());

string statusDetail = TransactionStatusBuilder.GetStatusDetail(data.StringValue());

break;

case AuthorizationRequest:

// Forward ARQC to processor.
/* data[0..1] – ARQC length
data[2..n] – remainder contains the ARQC TLV object
*/

IData processorARPC = new 
BaseData(sendForAuthorization(data.ByteArray()));

// Send authorization to device when not in QuickChip mode. 
if (transaction.QuickChip == false)
{
device.sendAuthorization(procesorARPC.ByteArray());
}

break;

case TransactionResult

/* data[0] – Signature Required
    data[1..2] – Batch Data length
    data[3..n] – remainder contains the Batch Data TLV object
*/

// Parse the TLV from data[].
.
// Abstract Approval status from TLV tag “DFDF1A”.
.
// Abstract Signature Required status from TLV tag data[0].
.

break;

// Establish a device from CoreAPI.
List<IDevice> deviceList = CoreAPI.getDeviceList(); IDevice device = deviceList[0];

// Establish a deviceControl from device.
IDeviceControl deviceControl = device.getDeviceControl();

// Open the device, then use the IDeviceControl functions. deviceControl.open();

. . .

// Close the device. deviceControl.close();

// Establish a device from CoreAPI.
List<IDevice> deviceList = CoreAPI.getDeviceList(); 
IDevice device = deviceList[0];

// Establish a ConnectionInfo from device.
ConnectionInfo connectionInfo = device.getConnectionInfo();

// Retrieve address, connectionType, and deviceType. 
String address = connectionInfo.getAddress();
ConnectionType connectionType = connectionInfo.getConnectionType(); 
DeviceType deviceType = connectionInfo.getDeviceType();

 // Establish a device from CoreAPI.
List<IDevice> deviceList = CoreAPI.getDeviceList(); 
IDevice device = deviceList[0];

// Establish a IDeviceCapabilities from device. 
IDeviceCapabilities capabilities = device.getCapabilities();


// Retrieve device capabilities.
boolean batteryBackedClock = capabilities.BatteryBackedClock(); 
if (batteryBackedClock)
{
// Call IDeviceControl.setDateTime().
}

// Retrieve supported card payment methods.
List<PaymentMethod> paymentMethods = capabilities.PaymentMethods();

. . .

// Establish a device from CoreAPI.
List<IDevice> deviceList = CoreAPI.getDeviceList(); 
IDevice device = deviceList[0];

IDeviceConfiguration deviceConfiguration = 
    device.getDeviceConfiguration();

/* To handle events from some other class. ConfigCallBacks 
configCallBacks = new ConfigCallBacks();
*/

// Update firmware.
byte[] data = getDataFromURI(uri);
int return = deviceConfiguration.updateFirmware(1, data, this);

/* Get configuration.
    Device-Driven Fallback OID = 1.2.1.1.1.1
            contructed OID = E2 08 E1 06 E1 04 E1 02 C1 00
    Note: first digit of OID is ommited in the construction and instead is passed in the configType.
*/
byte configType = 0x01;
data = new byte[] {0xE2,0x08,0xE1,0x06,0xE1,0x04,0xE1,0x02,0xC1,0x00
};
byte[] response = devConfig.getConfigInfo(configType, data);


/* Set configuation.
    Device-Driven Fallback OID is 1.2.1.1.1.1
        Disabled contructed OID = E2 09 E1 07 E1 05 E1 03 C1 01 00
            Enabled contructed OID = E2 09 E1 07 E1 05 E1 03 C1 01 01
    Note: first digit of OID is ommited in the construction and instead 
is passed in the configType.

*/
data = new byte[]
{0xE2,0x09,0xE1,0x07,0xE1,0x05,0xE1,0x03,0xC1,0x01,0x00 };
result = devConfig.getConfigInfo(configType, data);

// A class to handle configuration callback events.
public class ConfigCallbacks implements IConfigurationCallback
{

    public void OnProgress(int progress)
    {
        /* Handle progress.
            Progress is complete when progress = 100 */
    }

public IResult OnCalculateMAC(byte macType, byte[] data)
{
    IResult result = new Result(StatusCode.UNAVAILABLE); 
    byte[] macBytes = null;
    
    DeviceType deviceType =
        device.getConnection Info().getDeviceType();

    switch (deviceType)
    {
        case DeviceType.MMS:
            macBytes = getDynaFlexMAC(macType, data); 
            break;
    }

    if (macBytes != null)
    {
        result = new Result(StatusCode.SUCCESS); 
        result.Data = new BaseData(macBytes);
    }

    return result;
    }

}

ConnectionInfo

Create an instance of the ConnectionInfo using IDevice.getConnectionInfo(). Then use the function calls described in this chapter.

getAddress

This function returns address of the device.

String ConnectionInfo.getAddress();

Return Value:

Returns the address of the device.

getConnectionType

This function returns the type of connection Interface for the device.

ConnectionType ConnectionInfo.getConnectionType();

Return Value:

Returns the ConnectionType.

getDeviceType

This function returns the type for the device.

DeviceType ConnectionInfo.getDeviceType();

Return Value:

Returns the DeviceFeature.

This enum refers to a featured supported by the device.

Enum

Description

IDeviceConfiguration

Create an instance of the IDeviceConfiguration using getDeviceConfiguration(). Then use the function calls described in this chapter.

Generally, these functions will run in one of two modes:

Asynchronous functions return data in the event handlers in section.
Synchronous functions return data in the return value. If the data is not available immediately, the call will block until a wait time has elapsed.

deleteFile

This function deletes a file from the device.

Copy

int IDeviceConfiguration.deleteFile(byte[] fileID);

Parameter

fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id. 0x02000000 = Custom idle page image 1
0x02000001 = Custom idle page image 2 0x02000002 = Custom idle page image 3 0x02000003 = Custom idle page image 4

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

This function retrieves a challenge token from the device. A challenge token consists of a random nonce or timestamp. A challenge token must be used within the time allowed by the device (generally 5 minutes) of being issued. Only one token can be active at a time. Attempts to use a token for requests other than the one specified will cause the token to be revoked/erased.

Copy

Parameter

data Byte array containing the request ID to be protected.

Return Value:

Returns a byte array containing the challenge token.

This function retrieves device configuration information.

Copy

Parameter

configType Type of configuration. For DynaFlex, this is the function ID.
data Configuration data to be sent to the device. For DynaFlex, this is the OID.

Return Value:

Returns an array of bytes containing the configuration information.

This function retrieves device specific information.

Copy

Parameter

infoType Enumerated information type.

Return Value:

Returns a string value device information.

This function retrieves device specific information.

Copy

Parameter

fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns a string value device information.

This function retrieves key information.

Copy

Parameter

keyType Type of key. For DynaFlex, use 0.
data Key data to be sent to the device. For DynaFlex, this is the 2-byte key slot number.

Return Value:

Returns an array of bytes containing the key information.

This function sends a file to the device.

Copy

Parameter

fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
data File contents to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

This function sends an image to the device.

Copy

Parameter

imageID Value for the image ID. For DynaFlex, use:
1, 2, 3, or 4
data File contents to be sent to the device.
Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.
For details see D998200383 DynaFlex Family Programmer's Manual (Commands).

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

This function sends a file to the device using a secure command structure.

Copy

Parameter

fileID Byte array for the file ID. For DynaFlex, use a 4-byte file id.
data File contents to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

This function sets device configuration information.

Copy

Parameter

configType Type of configuration. For DynaFlex, this is the function ID.
data Configuration data to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value.

This function sets which image is to be displayed when the device is idle.

Copy

Parameter

imageID Value for the image ID. For DynaFlex, use:
0, 1, 2, 3, or 4
Where 0 substitutes the “Welcome” screen.

Return Value:

Returns 0 if the asynchronous configuration operation started. Otherwise, returns a non 0 value.

This function updates the device firmware.

Copy

Parameter

firmwareType Type of firmware. For DynaFlex, use:
1 - Main App
data Firmware image to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

This function updates key information in the device.

Copy

Parameter

keyType Type of key.
data Key data to be sent to the device.
callback Name of a class or structure that implements the IConfigurationCallback Delegates events.

Return Value:

Returns 0 if the asynchronous update operation started. Otherwise, returns a non 0 value.

IConfigurationCallback Delegates

MTUSDKNET API will invoke the callback function in this chapter to provide the requested data and/or a detailed response. These events will be called in a class that implements the IConfigurationCallback Delegates interface.

OnCalculateMAC

This event is called when certain asynchronous IDeviceConfiguration operations need to be have a MAC included with the request.

Copy

IResult OnCalculateMAC( 
    byte macType, 
    byte[] data);

Parameter

Description

macType

Return Value:

Returns an IResult that contains the calculated MAC.

This event is called to update the host on the progress of an asynchronous IDeviceConfiguration operation.

public void OnProgres(int progress);

Parameter

Description

Return Value: None

This event is called to update the host when an asynchronous IDeviceConfiguration operation is completed.

Copy

Parameter

Description

Return Value: None

Example:

Copy

For the complete documentation index, see . This page is also available as .

class OnConfigCallbackClass implements IConfigurationCallBack
{
    public IResult OnCalculateMAC(byte macType, byte[] data)
    {
        // Event handler
    }

    public void OnProgress(int progress)
    {
        // Event handler
    }

    public void OnResult(StatusCode status, byte[] data)
    {
        // Event handler
    }

}

OnConfigCallbackClass configCallBack = new OnConfigCallbackClass();

IDeviceCapabilities

Create an instance of the IDeviceCapabilities using IDevice.getCapabilities(). Then use the functions described in this chapter.

BatteryBackedClock

This property returns true if the device is equipped with a battery that preserves the internal clock when not powered by a host system or charging.

Copy

boolean IDeviceCapabilities.BatteryBackedClock();

Return Value:

Returns true if device is equipped with a battery backed clock. Otherwise, returns false.

Display

This property returns true if the device is equipped with display.

Copy

boolean IDeviceCapabilities.Display();

Return Value:

Returns true if device is equipped with a display. Otherwise, returns false.

This property returns true if the device has the option to disable or enable the magnetic stripe reader head (MSR). The MSR may be powered down while the device is idle to minimize power consumption.

Copy

Return Value:

Returns true if device supports MSR power saver. Otherwise, returns false.

This property returns an enumerate list of payment methods supported by the device.

Copy

Return Value:

Returns a list of PaymentMethod.

This property returns true if the device is equipped with a PIN Pad.

Copy

Return Value:

Returns true if device is equipped with a PIN Pad. Otherwise, returns false.

This property returns true if the device is equipped with signature capture.

Copy

Return Value:

Returns true if device is equipped with signature capture. Otherwise, returns false.

This property returns true if the device supports Secure Reading and Exchange of Data.

Copy

Return Value:

Returns true if device supports SRED. Otherwise, returns false.

var

Appendix A - Status Codes

public enum StatusCode
{
    SUCCESS = 0,
    TIMEOUT = 1,
    ERROR = 2,
    UNAVAILABLE = 3
}

Enum

Description

SUCCESS

The operation completed successfully.

TIMEOUT

The operation timed out.

Classes - A - I

These classes are equipped with helper classes named Builders. Builders can parse the raw data byte array of an OnEvent() into a format required by a builder’s class.

For the complete documentation index, see llms.txt. This page is also available as .

BarCodeData

These constructors initialize a BarCodeData object. Use BarCodeDataBuilder.GetBarCodeData with data from the BarCodeData event to return a BarcodeData.

BarCodeData BarCodeDataBuilder.GetBarCodeData( 
    DeviceType deviceType, 
    byte[] dataBytes 
    );
    
new BarCodeData(byte[] Data, boolean Encrypted); 
new BarCodeData(
    byte[] Data, 
    boolean Encrypted,
    byte EncryptionType, 
    byte[] KSN
    );

Member

Description

Return Value: Returns an instance of BarCodeData.

CertificateInfo is used for the connection to a device requiring client credentials. See the following for details on installing a certificate chain: D998200550 DynaFlex II PED Using Wireless LAN Guide.

This constructor initialize a CertificateInfo object. Once created, it is to be passed to CoreAPI.createDevice().

Parameter / Member

Type / Format

Description

Return Value: Returns an instance of Certificate Info. Example of using CertificateInfo.

This class returns the connection state of the device when supplied the data object of the OnEvent() ConnectionState event.

Member

Description

Return Value: Returns an instance of ConnectionStateBuilder.

DirectoryEntry is similar to an InputRequest for Application during a transaction. Other fields of information are included besides Application Label. During a transaction, the device selects the PPSE. The directory entries are the PPSE response starting from the BF0C tag. The number of directory entries correspond to the number of applications on the card.

These constructors initialize a DirectoryEntry object.

Parameter

Type

Description

Return Value: Returns an instance of DirectoryEntry.

This supplies a directory entry list for application selection after a card has been presented to the device during a transaction. To be implemented, Application Selection Behavior property 1.2.1.1.1.2 must be set to 0x03 – Enhanced Prompt Cardholder.

The data byte array from the EnhancedInputRequest event is parsed and returned as an enhanced application selection list (directory entry). This list is the PPSE response starting from tag BF0C. EnhancedInputRequest class extends InputRequest.

Member

Return

Description

IData is used for the payload of events and passing data to functions. When assigning the member StringValue, the member ByteArray is automatically assigned. Same is true vice versa. In this way either a string or an array can be accessed without need of data conversion.

Use the BaseData() function to assign an instance of IData.

Member

Type / Format

Description

Example of using IData.

This is used for displaying messages prompted by the card during a transaction. The data byte array from the InputRequest event is parsed and returned as an application selection list.

Member

Type / Format

Description

Static Member

Value

Description

Return Value: Returns an instance of InputRequest.

This is the interface used as the parameter for startTransaction(). For an example, see the sample code in IDevice Walk Through.

Parameter

Type / Format

Description

new DirectoryEntry(); 
new DirectoryEntry( 
    String Aid, 
    String Label, 
    byte Priority, 
    byte[] ProprietaryData, 
    byte KernelIdentifier, 
    byte[] IssuerIN, 
    byte[] IssuerINE,
    byte[] IssuerCountryCodeAlpha2, 
    byte[] IssuerCountryCodeAlpha3, 
    byte[] CardProductDetails
    );

IDevice

cancelTransaction

This function cancels a transaction. A transaction can only be cancelled before a card is presented.

boolean IDevice.cancelTransaction();

Return Value: Returns true if cancelled. Otherwise, returns false.

getCapabilities

This function retrieves the capabilities of the device.

IDeviceCapabilities IDevice.getCapabilities();

Return Value: Returns IDeviceCapabilities

getConnectionInfo

This function retrieves the connection information of the device.

ConnectionInfo IDevice.getConnectionInfo();

Return Value: Returns ConnectionInfo

getConnectionState

This function retrieves the connection state of the device.

ConnectionState IDevice.getConnectionState();

Return Value: Returns CaptureType

This enum refers to the type of customer information to capture.

Enum

Description

This function allows the host to get an IDeviceConfiguration to configure the device.

Return Value: Returns IDeviceConfiguration.

This function retrieves the device control interface to the device.

Return Value: Returns IDeviceControl

This function returns an information class of the device.

Return Value: Returns DeviceInfo.

This function returns the name of the device assigned from createDevice().

String IDevice.Name();

Return Value: Returns the name of the device.

This function prompts the user to present their card and enter a PIN. A card is presented so that the device can retrieve the PAN, which is used for Format blocks requiring a PAN. The encrypted PIN block (EPB) will be returned in the event OnEvent. The data byte array may be passed to builder function PANDataBuilder.GetPANData();

For DynaFlex devices, this function starts a PIN session on the first call and shall be called again to send the PIN status to the device for completing the PIN session.

Parameter

Type

Description

Parameter

Type

Description

Return Value: Returns true if successful. Otherwise, returns false.

This function prompts the user to enter a PIN. The host must supply the PAN if the Format block selected requires a PAN. The encrypted PIN block (EPB) will be returned in the event OnEvent. The data byte array may be passed to builder function PINDataBuilder.GetPINData();

For DynaFlex devices, this function starts a PIN session on the first call and shall be called again to send the PIN status to the device for completing the PIN session.

Parameter

Type

Description

Return Value: Returns true if successful. Otherwise, returns false.

This function prompts the user to enter a signature. The response data will be returned in the event OnEvent.

Return Value: Returns true of successful. Otherwise, returns false.

This function sends the Authorization Response Code (ARPC) blob to the device. The response data will be returned in the event OnEvent. See EMV Transaction Flow for how to process an EMV transaction.

Parameter

Description

Return Value: Returns true if successful. Otherwise, returns false.

This function sends a command to a NFC Mifare Classic Tag type 2. The NFC tag must first be activated by calling startTransaction() with NFC enabled.

Parameter

Description

Return Value: Returns true if successful. Otherwise, returns false.

Command

Length

Field Value

Tag

Len

Value / Description

If unencrypted:

Tag

Len

Value / Description

If encrypted:

Tag

Len

Value / Description

Example Unencrypted Payload

Example Encrypted Payload for Fast Read

This function sends a command to an NFC Mifare DESFire Tag Type 4. The NFC tag must first be activated by calling startTransaction() with NFC enabled.

Parameter

Description

Return Value: Returns true if successful. Otherwise, returns false.

Tag

Len

Value / Description

Tag

Len

Value / Description

Tag

Len

Value / Description

This function send a user selection to the device.

Parameter

Description

Return Value: Returns true if successful. Otherwise, returns false.

This function send a user selection to the device.

Parameter

Description

Return Value: Returns true if successful. Otherwise, returns false.

This function starts a transaction. This function will automatically handle the opening and closing of a device. The transaction will be processed through multiple calls to the event OnEvent. See EMV Transaction Flow for how to process an EMV transaction.

Parameter

Description

Return Value: Returns true if the transaction started successfully. Otherwise, returns false.

This function allows the host to be notified of all events sent by the device.

Parameter

Description

Return Value: Returns true if successful.

This function allows the host to no longer receive any events sent by the device.

Parameter

Description

Return Value: Returns true if successful.

81	0100 (Tag Respons Code)
82	82036D (Encryption Control)
    FC 820369 (NFC Data Container) DF7A 820364 (NFC Data)
        031391010F55047777772E6D616774656B2E636F6DFE00. . .
                www.magtek.com

81	0100 (Tag Response code)
82	820389 (Encryption Control)
    DFDF59 820370 (Encrypted Data Primitive) 
        03679DC03B4CA607E3A7D2B52C8E9F1B5CD3D85E7368425. . .
    DFDF50 0A (Encrypted Data KSN) 
        FFFF9876543210200047
    DFDF51 01 (Encrypted Data Type) 
        80

81	0100 (Tag Respons Code)
82	82036D (Encryption Control)
    FC 820369 (NFC Data Container) 
        DF7A 820364 (NFC Data)
            031391010F55047777772E6D616774656B2E636F6DFE00. . .
                    www.magtek.com

81	0100 (Tag Response code)
82	820389 (Encryption Control)
    DFDF59 820370 (Encrypted Data Primitive) 
        03679DC03B4CA607E3A7D2B52C8E9F1B5CD3D85E7368425. . .
    DFDF50 0A (Encrypted Data KSN) 
        FFFF9876543210200047
        DFDF51 01 (Encrypted Data Type) 
                80

Classes - N - Z

NFCData

These constructors initialize an NFCData object. Use NFCDataBuilder.GetNFCData with the data byte array from the NFCData event to return an NFCData.

NFCData NFCDataBuilder.GetNFCData(deviceType, byte[] dataBytes); 
new NFCData(byte[] Data, boolean Encrypted); 
new NFCData(
    byte[] Data, 
    boolean Encrypted,
    byte EncryptionType, 
    byte[] KSN
    );

Member

Description

Data()

Returns the data payload.

Encrypted()

Return Value:

Returns an instance of NFCData.

These constructors initialize an NFCRAPDUData object. Use NFCDataBuilder.GetNFCRAPDUData with data byte array from the NFCRAPDUResponse event to return an NFCRAPDUData.

Parameter

Description

Return Value:

Returns an instance of NFCRAPDUData.

This class assist in parsing NFCEvent data.

Member

Return

Description

Member

Value

Description

These constructors initialize a PersonalInfoEntry object.

Call startPersonalInfoEntry().
At OnEvent():TouchscreenPersonalInfoEntry, build the object.

Member

Description

Return Value:

Returns an instance of PersonalInfoEntry.

NFCRAPDUData NFCRAPDU( 
    byte[] response, 
    byte[] data, 
    boolean encrypted, 
    );
    
NFCRAPDUData NFCRAPDU(
    byte[] response, 
    byte[] data, 
    bool encrypted, 
    byte encryptionType, 
    byte[] ksn
    );
    
NFCRAPDUData NFCDataBuilder.GetNFCRAPDUData( 
    DeviceType deviceType,
    byte[] dataBytes,
    );

PersonalInfoEntry PersonalInfoEntryBuilder.GetPersonalInfoEntry( 
DeviceType deviceType, 
byte[] dataBytes);

new PersonalInfoEntry( 
    byte[] data, 
    CaptureType dataType, 
    bool encrypted,
    );

new PersonalInfoEntry( 
    byte[] data, 
    CaptureType dataType, 
    bool encrypted, 
    byte encryptionType, 
    byte[] ksn 
    );

Appendix C - EMV Transaction Flow

This section demonstrates transaction flow.

Flow Chart - QuickChip

Sample Code - QuickChip

The following breaks out the EMV flow chart into code. When enabling QuickChip mode, host does not send the ARPC to the device to complete the transaction. Events are shown separately and in the order received.

// Assign parameters.
List<PaymentMethod> paymentMethod = new List<PaymentMethod>(); 
paymentMethod.Add(PaymentMethod.MSR); 
paymentMethod.Add(PaymentMethod.Contact); 
paymentMethod.Add(PaymentMethod.Contactless);

Transaction transaction = new Transaction(); 
transaction.setAmount(“1.00”); 
transaction.setCashBack(“0.00”); 
transaction.setEMVOnly(true); 
transaction.setPaymentMethods(paymentMethod); 
transaction.setQuickChip(true); // QuickChip mode enabled.

// Start transaction.
boolean result = device.startTransaction(transaction);

public void OnEvent(EventType eventType, IData data)
{
    String message 
    switch (eventType);
        {
            case EventType.DisplayMessage:
                // Get the message.
                message = data.StringValue();
    }
}

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.InputRequest:
            // Get the message.
            message = data.StringValue();

            // display/retrieve user selection.

            // set status and selection result.
            IData selectionData = new BaseData(new Byte[] {status, selection});
            device.sendSelection(selectionData);
    }
}

public void OnEvent(EventType eventType, IData data)
{
byte[] ARQC = null; 
switch (eventType);
    {
        case EventType.AuthorizationRequest:
            // Forward ARQC to processor.
            /* data[0..1] – ARQC length
                data[2..n] – remainder contains the ARQC TLV object */
    }
}

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
        
            case EventType.TransactionResult:
                /* data[0]	– Signature Required 
                    data[1..2] – Batch Data length
                    data[3..n] – remainder contains the Batch Data TLV object
                */

                // Parse the TLV from data[].
                // Abstract Approval status from TLV tag “DFDF1A”.
                // Abstract Signature Required status from TLV tag data[0].
        }
}

Flow Chart – Signature Capture

Sample Code – Signature Capture

The following breaks out the EMV flow chart into code. Events are shown separately and in the order received.

// Assign parameters.
List<PaymentMethod> paymentMethod = new List<PaymentMethod>(); 
paymentMethod.Add(PaymentMethod.MSR); 
paymentMethod.Add(PaymentMethod.Contact); 
paymentMethod.Add(PaymentMethod.Contactless);

Transaction transaction = new Transaction(); 
transaction.setAmount(“1.00”); 
transaction.setCashBack(“0.00”); 
transaction.setEMVOnly(true); 
transaction.setPaymentMethods(paymentMethod); 
transaction.setQuickChip(true);

// Start transaction.
boolean result = device.startTransaction(transaction);

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.DisplayMessage:

                // Get the message.
                message = data.StringValue();
    }
}

public void OnEvent(EventType eventType, IData data)
{
    byte[] ARQC = null; 
    switch (eventType);
        {
            case EventType.AuthorizationRequest:
                // #4a
                // Forward ARQC to processor.
                /* data[0..1] – ARQC length
                    data[2..n] – remainder contains the ARQC TLV object */
        }
}

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.DisplayMessage:
                // Display approval message. 
                message = data.StringValue();

                // A data size of 0 is an instruction to clear the display. 
                if (data.StringValue().Length == 0)
                {
                    // Clear the UI display.
                }
        }
}

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.TransactionResult:
                /* data[0]	– Signature Required 
                data[1..2] – Batch Data length
                data[3..n] – remainder contains the Batch Data TLV object
                */

                // Parse the TLV from data[].
                // Abstract Approval status from TLV tag “DFDF1A”.
                // Abstract Signature Required status from TLV tag data[0].
        }
}

public void OnEvent(EventType eventType, IData data)
{
    String signature; 
    switch (eventType);
        {
            case EventType.Signature: 
                signature = data.StringValue();
        }
}

Flow Chart – With ARPC

Sample Code – With ARPC

The following breaks out the EMV flow chart into code. When disabling QuickChip mode, host must send the ARPC to the device to complete the transaction. Events are shown separately and in the order received.

// Assign parameters.
List<PaymentMethod> paymentMethod = new List<PaymentMethod>(); 
paymentMethod.Add(PaymentMethod.MSR); 
paymentMethod.Add(PaymentMethod.Contact); 
paymentMethod.Add(PaymentMethod.Contactless);

Transaction transaction = new Transaction(); 
transaction.setAmount(“1.00”); 
transaction.setCashBack(“0.00”); 
transaction.setEMVOnly(true); 
transaction.setPaymentMethods(paymentMethod); 
transaction.setQuickChip(false); //QuickChip mode disabled.

// Start transaction.
boolean result = device.startTransaction(transaction);

public void OnEvent(EventType eventType, IData data)
{
    string message; 
    switch (eventType);
        {
            case EventType.DisplayMessage:

                // Get the message.
                message = data.StringValue;
    }
}

public void OnEvent(EventType eventType, IData data)
{
    string message; 
    switch (eventType);
        {
            case EventType.InputRequest:
                // Get the message.
                message = data.StringValue;

                // display/retrieve user selection.

                // set status and selection result.
                IData selectionData = new BaseData(new Byte[] {status, selection});
device.sendSelection(selectionData);
    }
}

public void OnEvent(EventType eventType, IData data)
{
    byte[] ARQC = null; 
    switch (eventType);
        {
            case EventType.AuthorizationRequest:
                // Forward the ARQC to the processor.
                /* data[0..1] – ARQC length
                data[2..n] – remainder contains the ARQC TLV object */

                ARQC.ByteArray = data.ByteArray;
                // App function to send the request to the processor. 
                ARPC = sendARQCToProcessorForApproval(ARQC.ByteArray());

        }
}

After the ARPC is returned from the processor, it is constructed into a TLV container and then sent to the device. The ARPC for approved (00) is set in ASCII 3030.

The optional tags 91, 71, and 72 (Issuer Authentication Data, Issuer Script Template 1, and Issuer Script Template 2) are not included in this example.

See the construction of the ARPCTLV in the table below.

ARPC TLV object for sendAuthorization().

Tag

Len

Value / Description

Typ

Req

Default

The use case for an MSR fallback is when communication with the chip results in a terminated transaction and the TransactionStatus is reported as MSRFallback.

The host application will re-attempt the transaction. To invoke this use case, here are the following pre-requisites.

Pre-requisites:

Device already configured for Device-Driven Fallback = Disabled.
A card to cause the fallback. Example but not limited to a card with no applications programmed or a card with an application not configured on the device.

Scheme:

-->Host begins an initial transaction with PaymentMethod set to MSR+Chip+Contactless.
<--Device responds with fail and with status of MSRFallback.
-->Host displays a message to use magstripe.
-->Host starts a transaction with PaymentMethod set to MSR.

Begin initial transaction:

Continue with Fallback transaction:

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.DisplayMessage:
                // Display approval message. 
                message = data.StringValue();

                // A data size of 0 is an instruction to clear the display. 
                if (data.StringValue().Length == 0)
                {
                    // Clear the UI display.
                }
        }
}

public void OnEvent(EventType eventType, IData data)
{
    String message; 
    switch (eventType);
        {
            case EventType.TransactionResult:
                /* data[0]	– Signature Required 
                data[1..2] – Batch Data length
                data[3..n] – remainder contains the Batch Data TLV object
        */

        // Parse the TLV from data[].
        // Abstract Approval status from TLV tag “DFDF1A”.
        // Abstract Signature Required status from TLV tag data[0].
    }
}

public void OnEvent(EventType eventType, IData data)
{
    String signature; 
    switch (eventType);
        {
            case EventType.Signature: 
                signature = data.StringValue();
        }
}

IDeviceControl

Create an instance of the IDeviceControl using IDevice.getDeviceControl(). Then use the function calls described in this chapter.

Generally, these functions will run in one of two modes:

Asynchronous functions return data in the event handlers in section
Synchronous functions return data in the return value. If the data is not available immediately, the call will block until a wait time has elapsed.

close

This function closes the connection to the device.

boolean IDeviceControl.close();

Return Value:

Returns true if successful. Otherwise, returns false.

This function resets the device. This is equivalent to a power reset. After the reset, connection to the device will need to be re-established.

Return Value:

Returns true if successful. Otherwise, returns false.

This function displays a message on the device’s screen.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function clears session data and returns the device to an idle state.

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a request for user input to the device. The response data will be returned in the event

OnEvent.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function opens a connection to the device.

Return Value:

Returns true if successful. Otherwise, returns false.

This function instructs the device to play a tone.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to the device. The response will be passed to the event OnEvent.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends an extended command to the device. The response will be passed to the event

OnEvent

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a raw APDU command from the host application to the NFC target while the device is operating in NFC Pass-Through mode. For NFC Type A or Type B using ISO 14443-4 Protocol.

Used for applications that require direct APDU-level communication, such as mDL, secure element transactions, or custom NFC protocols.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a synchronous command to the device. The response from the device will be returned in IResult.

Parameter

Description

Return Value:

Returns IResult.

This function sets the date and time for the device.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function send a command to lock or unlock the card latch. The host can choose to lock the card during EMV transactions to limit the possibility of the cardholder prematurely removing the card. The lock can also be enabled while the card is out of the system to block cardholders from inserting a card.

Parameter

Description

false – unlock the latch in the device.
true – lock the latch in the device.

Return Value:

Returns true if successful. Otherwise, returns false.

This function controls the status of the device’s LED indicators (Light Emitting Diode) to provide visual feedback NFC operation states. Applicable after entering NFC Pass-Through mode. The status is reset after exiting NFC Pass-Through mode.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function commands the device to enter NFC Pass-Through Mode. This enables the host application to directly exchange APDU commands and responses with an NFC card or mobile device.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function configures the NFC reader polling behavior used to detect nearby NFC targets such as cards, mobile devices, or mDL wallets. Applicable after entering the Pass-Through mode.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to show a barcode on the device’s display.

Parameter

Description

Parameter

Type

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to immediately show an image on the device’s display.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to immediately show an image on the device’s display.

Parameter

Description

Member

Type/ Format

Description

Images must be BMP format, 160KB or smaller with no compression, maximum 320px by 240px, with color depth 16 color, 256 color, 16-bit color, or 24-bit color. Images smaller than the maximum size are centered on the display. Note images at full screen size must be 16-bit color or lower to meet the size requirement.

For details see D998200383 DynaFlex Family Programmer’s Manual (Commands).

Return Value:

Returns true if successful. Otherwise, returns false.

This function displays custom User Interface (UI) pages on devices that support a screen. It holds parameters for all UI page options of Text Lines, Text Buttons, Amount Buttons, and Image. Only one UI page option may be in effect at one time based on the option parameter. See the other subset functions for invoking a specific UI page.

When the UI page is active, the device waits for further action. The device notifies the host when a Button is pressed. Text Buttons and Functional Buttons report as the button number. Amount Buttons report the $ amount in BCD format. A press on a Text line does not produce a report.

Parameter

Description

0x00 = Up to 5 lines of text + 1 functional button Middle.

0x01 = Title + up to 6 text buttons + up to 3 functional buttons.

0x02 = Title + up to 6 $Amount buttons + up to 3 functional buttons.

0x03 = Title + custom image + 1 functional button Right.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function shows the Amount UI page.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function shows the Image UI page.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function shows the Text buttons UI page.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function shows the Text lines UI page.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to start the barcode reader.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to start card emulation.

Compliance: Conforms to ISO/IEC 14443 Type-A and NFC Forum Type 4 standards.
Passive Operation mode: The NFC reader must generate the field to activate the simulated card.
Read-Only: The emulated card is read-only and does not support writing.
Supported Data Type: Supports the URI (URL) data type.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to prompt a cardholder for customer information. Captured information is later returned in OnEvent() EventType.TouchscreenPersonalInfoEntry.

Parameter

Description

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to stop the barcode reader. This is applicable only when the timeout value for startBarCodeReader() was set to 0x00.

Return Value:

Returns true if successful. Otherwise, returns false.

This function sends a command to stop card emulation.

Return Value:

Returns true if successful. Otherwise, returns false.

This function stops the Personal Info Entry process. If called during info entry, the process will be canceled immediately.

Return Value:

Returns true if successful. Otherwise, returns false.

boolean showUIPage( 
    byte timeout, 
    byte option, 
    byte[] titleStringID, 
    String line1,
    String line2, 
    String line3, 
    String line4, 
    String line5, 
    byte[] stringID1, 
    byte[] stringID2, 
    byte[] stringID3, 
    byte[] stringID4, 
    byte[] stringID5, 
    byte[] stringID6, 
    byte[] amount1, 
    byte[] amount2, 
    byte[] amount3, 
    byte[] amount4, 
    byte[] amount5, 
    byte[] amount6,
    byte[] leftFButtonStringID, 
    byte[] middleFButtonStringID, 
    byte[] rightFButtonStringID, 
    byte leftFButtonColor,
    byte middleFButtonColor, 
    byte rightFButtonColor, 
    byte[] xPosition,
    byte[] yPosition, 
    byte[] imageData);

boolean showUIPageWithAmountButtons( 
    byte timeout, 
    byte[] titleStringID, 
    String[] buttonAmountList, 
    byte[] leftFButtonStringID, 
    byte[] middleFButtonStringID, 
    byte[] rightFButtonStringID,     
    byte leftFButtonColor, 
    byte middleFButtonColor, 
    byte rightFButtonColor); 
    
boolean showUIPageWithAmountButtons( 
    byte timeout, 
    byte[] titleStringID, 
    String amount1, 
    String amount2, 
    String amount3, 
    String amount4, 
    String amount5, 
    String amount6, 
    byte[] leftFButtonStringID, 
    byte[] middleFButtonStringID, 
    byte[] rightFButtonStringID, 
    byte leftFButtonColor, 
    byte middleFButtonColor, 
    byte rightFButtonColor); 
    
boolean showUIPageWithAmountButtons( 
    byte timeout, 
    byte[] titleStringID, 
    byte[] amount1, 
    byte[] amount2, 
    byte[] amount3, 
    byte[] amount4, 
    byte[] amount5, 
    byte[] amount6, 
    byte[] leftFButtonStringID, 
    byte[] middleFButtonStringID, 
    byte[] rightFButtonStringID, 
    byte leftFButtonColor, 
    byte middleFButtonColor, 
    byte rightFButtonColor);

boolean showUIPageWithTextButtons( 
    byte timeout, 
    byte[] titleStringID, 
    byte[] stringID1, 
    byte[] stringID2, 
    byte[] stringID3, 
    byte[] stringID4, 
    byte[] stringID5, 
    byte[] stringID6, 
    byte[] leftFButtonStringID, 
    byte[] middleFButtonStringID, 
    byte[] rightFButtonStringID, 
    byte leftFButtonColor, 
    byte middleFButtonColor, 
    byte rightFButtonColor);

boolean showUIPageWithTextLines( 
    byte timeout, 
    String[] lines, 
    byte[] middleFButtonStringID); 
    
boolean showUIPageWithTextLines( 
    byte timeout, 
    String line1, 
    String line2, 
    String line3, 
    String line4, 
    String line5, 
    byte[] middleFButtonStringID);

IEventSubscriber Delegates

MTUSDKNET API will invoke the callback function in this chapter to provide the requested data and/or a detailed response. To delegate the event, call the subscribeAll function with the name of a class that implements the IEventSubscriber Delegates interface.

OnEvent

OnEvent handles all event types. The eventType parameter defines which event is triggered.

public void OnEvent( 
    EventType eventType, 
    IData data);

Parameter

Description

eventType

Return Value: None

Example

In this example, the main window implements IEventSubscriber. The keyword this is used to pass in the name of the current class MainWindow.

Classes can be initialized by passing in the data byte array.

Example

public class OnEventClass implements IEventSubscriber
{
    public void OnEvent(EventType eventType, IData data)
    {
        // Event handler
    }

}

OnEventClass eventCallBack = new OnEventClass(); 
device.subscribeAll(evenCallBack);

public partial class MainWindow implements IEventSubscriber
{
    public void OnEvent(EventType eventType, IData data)
    {
        // Event handler
    }
    
    public void connectDevice()
    {
        device.subscribeAll(this);
    }
}

public void OnEvent(EventType eventType, IData data)
    {
        // Barcode data BarCodeData barcodeData =
BarCodeDataBuilder.GetBarCodeData(DeviceType.MMS, data.ByteArray());
 
    // Input request
    InputRequest ir = new InputRequest(data.ByteArray());
 
    // NFC data
    NFCData nfcData = NFCDataBuilder.GetNFCData(DeviceType.MMS, data.ByteArray());

    // Enhanced input request 
    EnhancedInputRequest eir = new
EnhancedInputRequest(data.ByteArray());
    List<DirectoryEntry> deList = eir.EnhancedSelectionList;
 
    }

IMQTTDeviceStatusCallback Delegates

This interface invokes callback functions to receive data and/or a detailed response. To register for the event(s), call the setMQTTDeviceStatusMonitoring() function with the name of a class that implements the IMQTTDeviceStatusCallback interface.

OnConnected

This event is called when a device is connected to the MQTT broker.

void OnConnected(String deviceAddress);

Parameter

Description

deviceAddress

Return Value: None

This event is called when a device is disconnected from the MQTT broker.

Parameter

Description

Return Value: None

Enumerations - B - E

BarCodeFormat

Enumerations - B - E

BarCodeFormat

BarCodeType

CaptureType

ConnectionState

ConnectionType

DataEntryType

DeviceEvent

DeviceFeature

DeviceType

ErrorType

EventType

ISystemStatusCallback Delegates

OnError

Enumerations

Enumerations

In This Section

Need More Help

CoreAPI

createCMSDevice

createDevice

createMMSDevice

createPPSCRA

createSCRA

getDeviceList

getAPIVersion

setMQTTBrokerInfo

setMQTTClientID

setMQTTClientCertificateInfo

setMQTTDeviceDiscoveryTimeout

startMQTTDeviceStatusMonitoring

setMQTTPublishTopic

setMQTTQos

setMQTTSubscribeTopic

stopMQTTDeviceStatusMonitoring

setSystemStatusCallback

Android

Universal SDK Documentation (Android)

In This Section

Need More Help

DeviceInfo

getModel

getName

Enumerations - F - V

FeatureStatus

Appendix B - API Walk Through

ImageType

InfoType

NFCDataMode

NFCEvent

NFCTransactionMode

OperationStatus

PaymentMethod

TransactionStatus

UserEvent

VASMode

VASProtocol

CoreAPI Walk Trough

IDevice Walk Through

Handling Events

Static members

PersonalInfoEntry

IDeviceControl Walk Through

ConnectionInfo Walk Through

IDeviceCapabilities Walk Through

IDeviceConfiguration Walk Through

Handling Events

ConnectionInfo

getAddress

getConnectionType

getDeviceType

IDeviceConfiguration

deleteFile

getChallengeToken

getConfigInfo

getDeviceInfo

getFile

getKeyInfo