com.symbol.emdk.payment

Class PaymentManager

java.lang.Object

com.symbol.emdk.EMDKBase

com.symbol.emdk.payment.PaymentManager

public class PaymentManager
extends EMDKBase

This is the primary object to access the payment feature.

 
  EMDKResults results = EMDKManager.getEMDKManager(getApplicationContext(), this);
   
  //After EMDK opened
  paymentManager = (PaymentManager)this.emdkManager.getInstance(FEATURE_TYPE.PAYMENT);

  PaymentDevice paymentDevice = paymentManager.getDevice(DeviceIdentifer.DEFAULT);
  paymentDevice.addDataListener(this);
  paymentDevice.enable();
  
  paymentDevice.readCardData();
  
  paymentDevice.disable();
  
  EMDKManager.release(FEATURE_TYPE.PAYMENT);
  
  
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PaymentManager.ConnectionState Connection states of a payment device.
static class	PaymentManager.DeviceIdentifier Defines specific payment devices of each type.
static interface	PaymentManager.PaymentConnectionListener An interface for notifying client applications when the external payment device is connected or disconnected to the mobile device.

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(PaymentManager.PaymentConnectionListener connectionListener, PaymentManager.DeviceIdentifier deviceIdentifier) Add PaymentConnectionListener to receive remote payment device connection changes via callback.
PaymentDevice	getDevice(DeviceInfo deviceInfo) This method returns the PaymentDevice object if the Device info specified is valid and Device info object can obtain from the PaymentManager.getSupportedDevicesInfo().
PaymentDevice	getDevice(PaymentManager.DeviceIdentifier deviceIdentifier) This method returns the PaymentDevice object based on device identifier specified.
PaymentDevice	getDevice(String deviceName, boolean isMacAddress) The getDevice method gets payment object which can be used to enable and communicate with payment device.
ArrayList<DeviceInfo>	getPairedDevicesInfo(DeviceInfo.DeviceType deviceType) This method gets the list of payment devices paired with Mobile Device based on the deviceType.
ArrayList<DeviceInfo>	getSupportedDevicesInfo() Returns list of supported payment devices information.
String	isPaymentDeviceInUse(DeviceInfo.DeviceType deviceType) This method checks whether the payment device is in use and which POS application is using the payment device The input parameter is payment device type.
void	removeConnectionListener(PaymentManager.PaymentConnectionListener connectionListener) Remove PaymentConnectionListener to receive payment device connection changes via callback.

Methods inherited from class com.symbol.emdk.EMDKBase

getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSupportedDevicesInfo

public ArrayList<DeviceInfo> getSupportedDevicesInfo()

Returns list of supported payment devices information.

Returns:

Returns list of payment devices information.

getDevice

public PaymentDevice getDevice(PaymentManager.DeviceIdentifier deviceIdentifier)

This method returns the PaymentDevice object based on device identifier specified. The PaymentDevice object created will be singleton object for that application instance for a specific type of payment device.

Parameters:

deviceIdentifier - The device identifier specifies which payment device the application wants.

Returns:

PaymentDevice object if the device identifier specified is valid on the device. Otherwise null is returned.

getDevice

public PaymentDevice getDevice(DeviceInfo deviceInfo)

This method returns the PaymentDevice object if the Device info specified is valid and Device info object can obtain from the PaymentManager.getSupportedDevicesInfo(). The PaymentDevice object created will be singleton object for a specific payment device.

Parameters:

deviceInfo - provides information on DeviceInfo class.

Returns:

PaymentDevice object if the deviceInfo specified is valid on the device. Otherwise null is returned.

getDevice

public PaymentDevice getDevice(String deviceName,
                               boolean isMacAddress)

The getDevice method gets payment object which can be used to enable and communicate with payment device. The getDevice method is a overload method which will access different values and returns the payment object for the device requested

Parameters:

deviceName - provides information like deviceName or macaddress of the devices.

isMacAddress - decides if deviceName is macaddress or the name of the device.

Returns:

PaymentDevice object if the PaymentDevice specified.Otherwise null is returned.

addConnectionListener

public void addConnectionListener(PaymentManager.PaymentConnectionListener connectionListener,
                                  PaymentManager.DeviceIdentifier deviceIdentifier)

Add PaymentConnectionListener to receive remote payment device connection changes via callback.

Parameters:

connectionListener -

deviceIdentifier - - Type of device connections to notify. Not supported in this version..

removeConnectionListener

public void removeConnectionListener(PaymentManager.PaymentConnectionListener connectionListener)

Remove PaymentConnectionListener to receive payment device connection changes via callback.

Parameters:

connectionListener -

getPairedDevicesInfo

public ArrayList<DeviceInfo> getPairedDevicesInfo(DeviceInfo.DeviceType deviceType)
                                           throws PaymentException

This method gets the list of payment devices paired with Mobile Device based on the deviceType. The Device can be PD40. The device info provides the information like device's mac address, friendly name and connection type.

Parameters:

deviceType -

Returns:

Returns list of DeviceInfo objects.

Throws:

PaymentException

isPaymentDeviceInUse

public String isPaymentDeviceInUse(DeviceInfo.DeviceType deviceType)

This method checks whether the payment device is in use and which POS application is using the payment device The input parameter is payment device type. This method returns the POS Application name if the payment is used.

Parameters:

deviceType -

Returns:

The return value is empty string if the payment device is not used by any POS app else returns the POS App name if the payment is used.