DeviceApi (net 3.1.5 API)

java.lang.Object
- com.so.net.DeviceApi

public final class DeviceApi
extends Object

Can control signature devices.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DeviceApi.BlackAndWhitePad` Functions for signature pads with black and white display.
`static class`	`DeviceApi.Button` Devices may have buttons.
`static class`	`DeviceApi.Communication` Can change how the DeviceApi communicatios with the signature devices.
`static class`	`DeviceApi.ContinuousScroll` Has types for controling the continuous scroll mode.
`static class`	`DeviceApi.ConvertImage` Can convert images to SOI and back.
`static class`	`DeviceApi.Crypto` A collection of cryptograpic functions most of which entail a signature device.
`static class`	`DeviceApi.Device` Device related types.
`static class`	`DeviceApi.Disconnect` Can set the disconnect callback.
`static class`	`DeviceApi.DocumentViewing` Can display documents on the device display.
`static class`	`DeviceApi.DriverXmlCertificate` Can set the driver XML certificate.
`static interface`	`DeviceApi.FailureCallback` The callback to call when a problem occurs during the loading of the .NET assemblies.
`static class`	`DeviceApi.FileSystem` Can read/write files from/to the device.
`static class`	`DeviceApi.Filter` Various device filters.
`static class`	`DeviceApi.License` Can set the License.
`static class`	`DeviceApi.PromoScreen` Can change the promoscreens.
`static class`	`DeviceApi.SDialog` Controls the simple dialog mode.
`static class`	`DeviceApi.SignatureImage` Can get the signature image and change related options.
`static class`	`DeviceApi.SignatureMode` Various signature modes.
`static class`	`DeviceApi.SignatureRectangle` Sets the area on the display of the signature device that is to be used for capturing the drawn signature.
`static class`	`DeviceApi.SignFinished` The signing is considered finished after the signer has stopped drawing for a certain timeout.
`static class`	`DeviceApi.SignHasTimedOut` The signing will time out when the signer does not start to draw for a certain timespan.
`static class`	`DeviceApi.SignImageChanged` Can set the SignImageChanged callback.
`static class`	`DeviceApi.SignStarted` Can set the SignStarted callback.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`calibrateSensor()` Starts a sensor calibration.
`static Optional<Boolean>`	`checkConnectedDevice(String deviceName)` Checks whether a device is connected.
`static void`	`close()` Frees unmanaged memory.
`static List<DeviceApi.Device.Name>`	`deviceSearch()` Search and select a device with a window.
`static List<DeviceApi.Device.Name>`	`deviceSearch(DeviceApi.Filter filter)` Search and select a device with a window.
`static Optional<String>`	`echo(String text)` Echos the given text.
`static List<DeviceApi.Device.Name>`	`enumerateDevices()` Enumerates the available devices.
`static List<DeviceApi.Device.Name>`	`enumerateDevices(DeviceApi.Filter filter)` Enumerates the available devices in a filtered way
`static void`	`findRuntimeConfig()`
`static Optional<Integer>`	`GetDeviceTransPortProtocol()` Gets the Protocol.
`static Optional<String>`	`getHello()` Gets a "Hello".
`static void`	`load()` Loads the shared library whose name starts with "SigDeviceAPI.WrapperNE".
`static void`	`preload_runtime()` Preloads the .NET runtime.
`static void`	`printResourcePrefix()`
`static boolean`	`resetDevice()` Resets all device options that are not persisted to the permanent storage of the device.
`static boolean`	`setAdminKeyToUnlockDevice(String key)` Performing restricted operations with the device require it to be unlocked with an adminKey.
`static boolean`	`setCustomerLogoMode()` Sets the device to the customer logo mode.
`static boolean`	`setDevice(DeviceApi.Device.Name device)` Sets the device to control.
`static boolean`	`SetDeviceTransPortProtocol(int protcol)` Sets the Protocol
`static boolean`	`setFailureCallback(DeviceApi.FailureCallback callback)` Sets the callback to call in case of failure during the loading of the .NET assemblies.
`static boolean`	`setSignatureRectangle()` Sets the standard signature rectangle, if any.
`static boolean`	`setSignatureRectangle(DeviceApi.SignatureRectangle signatureRectangle)` Sets the signature rectangle.
`static boolean`	`setSignBackground(BufferedImage image)` Sets the sign background
`static boolean`	`setSignBackground(BufferedImage image, int page, int numberOfPages)` Sets the sign background as well as the page number text in the form "page/numberOfPages".
`static void`	`setSuspendMode(boolean bval)`
`static boolean`	`startSignatureMode(DeviceApi.SignatureMode signatureMode)` Starts a signature mode.
`static boolean`	`stopSignatureCapture()`
`static Optional<Integer>`	`subtract(int a, int b)` Subtracts two numbers.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - load
```
public static void load()
```
    Loads the shared library whose name starts with "SigDeviceAPI.WrapperNE". Throws in case of error.
  - setSuspendMode
```
public static void setSuspendMode(boolean bval)
```
  - close
```
public static void close()
```
    Frees unmanaged memory. Please call it before the program exits.
  - setFailureCallback
```
public static boolean setFailureCallback(DeviceApi.FailureCallback callback)
```
    Sets the callback to call in case of failure during the loading of the .NET assemblies.
    
    Parameters:
    
    callback - The callback.
    
    Returns:
    
    True in case of success.
  - preload_runtime
```
public static void preload_runtime()
```
    Preloads the .NET runtime. Otherwise, the .NET runtime is loaded lazily.
  - getHello
```
public static Optional<String> getHello()
```
    Gets a "Hello".
    
    Returns:
    
    Some "Hello" in case of success.
  - subtract
```
public static Optional<Integer> subtract(int a,
                                         int b)
```
    Subtracts two numbers.
    
    Parameters:
    
    a - a
    
    b - b
    
    Returns:
    
    a - b in case of success.
  - echo
```
public static Optional<String> echo(String text)
```
    Echos the given text.
    
    Parameters:
    
    text - The text to echo.
    
    Returns:
    
    A copy of the input in case of success.
  - printResourcePrefix
```
public static void printResourcePrefix()
```
  - findRuntimeConfig
```
public static void findRuntimeConfig()
```
  - enumerateDevices
```
public static List<DeviceApi.Device.Name> enumerateDevices()
```
    Enumerates the available devices.
    
    Returns:
    
    A list of device names. An empty list in case of error.
  - enumerateDevices
```
public static List<DeviceApi.Device.Name> enumerateDevices(DeviceApi.Filter filter)
```
    Enumerates the available devices in a filtered way
    
    Parameters:
    
    filter - The device filter.
    
    Returns:
    
    A list of device names. An empty list in case of error.
  - deviceSearch
```
public static List<DeviceApi.Device.Name> deviceSearch()
```
    Search and select a device with a window.
    
    Returns:
    
    The device names.
  - deviceSearch
```
public static List<DeviceApi.Device.Name> deviceSearch(DeviceApi.Filter filter)
```
    Search and select a device with a window.
    
    Parameters:
    
    filter - How to filter the available devices.
    
    Returns:
    
    The device names.
  - setDevice
```
public static boolean setDevice(DeviceApi.Device.Name device)
```
    Sets the device to control.
    
    Parameters:
    
    device - The device name.
    
    Returns:
    
    True in case of success.
  - SetDeviceTransPortProtocol
```
public static boolean SetDeviceTransPortProtocol(int protcol)
```
    Sets the Protocol
    
    Parameters:
    
    protcol - 0 = USB-HID, 1 = not used Do not set, 2 = VCOM.
    
    Returns:
    
    True in case of success.
  - GetDeviceTransPortProtocol
```
public static Optional<Integer> GetDeviceTransPortProtocol()
```
    Gets the Protocol.
    
    Returns:
    
    Protocol 0 = USB-HID, 2 = VCOM, 3 = error.
  - startSignatureMode
```
public static boolean startSignatureMode(DeviceApi.SignatureMode signatureMode)
```
    Starts a signature mode.
    
    Parameters:
    
    signatureMode - Which mode to start.
    
    Returns:
    
    True in case of success.
  - stopSignatureCapture
```
public static boolean stopSignatureCapture()
```
  - setCustomerLogoMode
```
public static boolean setCustomerLogoMode()
```
    Sets the device to the customer logo mode.
    
    Returns:
    
    True in case of success.
  - calibrateSensor
```
public static boolean calibrateSensor()
```
    Starts a sensor calibration.
    
    Returns:
    
    True in case of success.
  - checkConnectedDevice
```
public static Optional<Boolean> checkConnectedDevice(String deviceName)
```
    Checks whether a device is connected.
    
    Parameters:
    
    deviceName - The name of the device as a character string.
    
    Returns:
    
    Some boolean in case of success.
  - setSignatureRectangle
```
public static boolean setSignatureRectangle()
```
    Sets the standard signature rectangle, if any.
    
    Returns:
    
    True in case of success.
    
    Since:
    
    0.0.23
  - setSignatureRectangle
```
public static boolean setSignatureRectangle(DeviceApi.SignatureRectangle signatureRectangle)
```
    Sets the signature rectangle.
    
    Parameters:
    
    signatureRectangle - The signature rectangle.
    
    Returns:
    
    True in case of success.
  - setSignBackground
```
public static boolean setSignBackground(BufferedImage image)
```
    Sets the sign background
    
    Parameters:
    
    image - The image.
    
    Returns:
    
    True in case of success. To be used with the DeviceApi.SignatureMode.SignInDocument mode.
  - setSignBackground
```
public static boolean setSignBackground(BufferedImage image,
                                        int page,
                                        int numberOfPages)
```
    Sets the sign background as well as the page number text in the form "page/numberOfPages". Requires NativeDeviceAPI v1.1.2 or NativeSignAPI v1.0.19 or higher.
    
    Parameters:
    
    image - The image.
    
    page - The page number.
    
    numberOfPages - The number of pages.
    
    Returns:
    
    True in case of success.
    
    Since:
    
    0.0.22
  - resetDevice
```
public static boolean resetDevice()
```
    Resets all device options that are not persisted to the permanent storage of the device.
    
    Returns:
    
    True in case of error.
  - setAdminKeyToUnlockDevice
```
public static boolean setAdminKeyToUnlockDevice(String key)
```
    Performing restricted operations with the device require it to be unlocked with an adminKey.
    
    Parameters:
    
    key - The key.
    
    Returns:
    
    True in case of success.

Class DeviceApi

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

load

setSuspendMode

close

setFailureCallback

preload_runtime

getHello

subtract

echo

printResourcePrefix

findRuntimeConfig

enumerateDevices

enumerateDevices

deviceSearch

deviceSearch

setDevice

SetDeviceTransPortProtocol

GetDeviceTransPortProtocol

startSignatureMode

stopSignatureCapture

setCustomerLogoMode

calibrateSensor

checkConnectedDevice

setSignatureRectangle

setSignatureRectangle

setSignBackground

setSignBackground

resetDevice

setAdminKeyToUnlockDevice