com.six.timapi

Class ShowSignatureCaptureResponse

java.lang.Object

com.six.timapi.ShowSignatureCaptureResponse

public class ShowSignatureCaptureResponse
extends Object

Contains the result of a show signature capture request finished after calling Terminal.showSignatureCapture(com.six.timapi.ShowSignatureCaptureRequest) or Terminal.showSignatureCaptureAsync(com.six.timapi.ShowSignatureCaptureRequest). Immutable class.

Constructor Summary

Constructors

Constructor and Description
ShowSignatureCaptureResponse(Reason reason, ImageFileFormat imageFileFormat, int imageWidth, int imageHeight, byte[] imageData) Create show signature capture response.

Method Summary

Modifier and Type	Method and Description
Image	getImage() Image object build from image data or null if image data is invalid.
byte[]	getImageData() Image data.
ImageFileFormat	getImageFileFormat() File format of image data.
int	getImageHeight() Image height in pixels.
int	getImageWidth() Image width in pixels.
Reason	getReason() Reason for closing dialog
String	toString() String representation for debugging purpose.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShowSignatureCaptureResponse

public ShowSignatureCaptureResponse(Reason reason,
                                    ImageFileFormat imageFileFormat,
                                    int imageWidth,
                                    int imageHeight,
                                    byte[] imageData)
                             throws IOException

Create show signature capture response.

Throws:

IOException - Failed creating image.

Method Detail

getReason

public Reason getReason()

Reason for closing dialog

getImageFileFormat

public ImageFileFormat getImageFileFormat()

File format of image data.

getImageWidth

public int getImageWidth()

Image width in pixels.

getImageHeight

public int getImageHeight()

Image height in pixels.

getImageData

public byte[] getImageData()

Image data.

getImage

public Image getImage()

Image object build from image data or null if image data is invalid.

toString

public String toString()

String representation for debugging purpose.

Overrides:

toString in class Object