| java.lang.Object | |
| ↳ | com.pspdfkit.signatures.BiometricSignatureData |
Class Overview
Biometric data of a Signature. Biometric data contains timing, pressure sensitivity, and
general input information that was collected while writing the signature. The biometric data can
be written to a PDF document while digitally signing using a Signer. Create instances of this class using the BiometricSignatureData.Builder.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | BiometricSignatureData.Builder | Builder for BiometricSignatureData. |
|||||||||
| enum | BiometricSignatureData.InputMethod | Types of input devices that for creating a signature. | |||||||||
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
android.os.Parcelable
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| BiometricSignatureData() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract BiometricSignatureData.InputMethod |
getInputMethod()
Returns input method that was used to create the signature.
| ||||||||||
| final List<Float> |
getPressurePoints()
Returns pressure points that were collected during signature creation.
| ||||||||||
| final List<Long> |
getTimePoints()
Returns time points that were registered during signature creation.
| ||||||||||
| abstract Float |
getTouchRadius()
Returns touch radius of the input device.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
android.os.Parcelable
| |||||||||||
Public Constructors
public BiometricSignatureData ()
Public Methods
public abstract BiometricSignatureData.InputMethod getInputMethod ()
Returns input method that was used to create the signature.
Returns
BiometricSignatureData.InputMethodthat was used for creating the signature ornull.
public final List<Float> getPressurePoints ()
Returns pressure points that were collected during signature creation. The returned list is
immutable. May be null if no pressure points were collected. The unit and range of
values is defined by the input type and may vary. Usually, this will be a value between
0f (no pressure) and 1f (full pressure) as provided by the getPressure() property.
Returns
- Immutable list of pressure points or
null.
public final List<Long> getTimePoints ()
Returns time points that were registered during signature creation. Time points are
milliseconds since the start of drawing the signature (the first time point will be `0`). The
returned list is immutable. May be null if no time points were collected.
Returns
- Immutable list of time points (in milliseconds) or
null.
public abstract Float getTouchRadius ()
Returns touch radius of the input device. The radius is a float value in the interval [0, 1] and represents the "thickness" of the input device.
Returns
- Touch radius of the input device or
nullif the radius is not known.