com.cloudpos.signature

Interface SignatureDevice

All Superinterfaces:

Device

public interface SignatureDevice
extends Device

The SignatureDevice interface defines the API for capturing signatures through applications.

A signature device object is obtained from the POSTerminal as follows:

 SignatureDevice signatureDevice =
         (SignatureDevice) POSTerminal.getInstance().getDevice("com.cloudpos.device.signature");
 

The string "com.cloudpos.device.signature" is used to identify the signature device, as defined by the specific implementation.

Applications can use this interface to control signature capture operations and must request the necessary permissions:

<uses-permission android:name="android.permission.CLOUDPOS_SIGNATURE"/>

See Also:

Device

Method Summary

Modifier and Type	Method and Description
void	listenSignature(java.lang.String transactionCode, OperationListener listener, int timeout) Initiates an asynchronous operation to capture a signature.
void	open(int logicID) Opens the signature device.
SignatureOperationResult	waitSignature(java.lang.String transactionCode, int timeout) Synchronous counterpart of listenSignature(String, OperationListener, int).

Methods inherited from interface com.cloudpos.Device

cancelRequest, close, getFailCount, getUsageCount, open

Method Detail

open

void open(int logicID)
   throws DeviceException

Opens the signature device.

Parameters:

logicID - Logical ID of the device to open.

Throws:

DeviceException - for standard errors as documented in DeviceException.

listenSignature

void listenSignature(java.lang.String transactionCode,
                     OperationListener listener,
                     int timeout)
              throws DeviceException

Initiates an asynchronous operation to capture a signature. The method will listen until a signature is written or a timeout occurs.

OperationListener.handleResult(OperationResult) will be called upon completion or timeout of the signature capture.

This method supports a timeout mechanism. The device must be able to respond to Device.cancelRequest() to abort the operation if needed.

In case of a timeout, the operation result will contain the error code OperationResult.ERR_TIMEOUT, with no signature data available.

Parameters:

transactionCode - A transaction code associated with the signature capture.

listener - The OperationListener to handle the result.

timeout - The maximum time allowed for capturing the signature, in milliseconds.

Throws:

DeviceException - for standard errors as documented in DeviceException.

See Also:

OperationListener.handleResult(com.cloudpos.OperationResult)

waitSignature

SignatureOperationResult waitSignature(java.lang.String transactionCode,
                                       int timeout)
                                throws DeviceException

Synchronous counterpart of listenSignature(String, OperationListener, int). Waits for a signature to be captured or a timeout to occur.

Parameters:

transactionCode - A transaction code associated with the signature capture.

timeout - The maximum time allowed for capturing the signature, in milliseconds.

Returns:

The result of the signature capture operation.

Throws:

DeviceException - for standard errors as documented in DeviceException.