SignDoc SDK (.NET with exceptions)  5.0.0
Public Member Functions | Static Public Member Functions | List of all members
SignDocCheckSignatureParameters Class Reference

Parameters for SignDocSignatureData.checkReference() and SignDocSignatureData.checkSignature(). More...

Public Member Functions

 ~SignDocCheckSignatureParameters ()
 Destructor. More...
 
 !SignDocCheckSignatureParameters ()
 Finalizer. More...
 
 SignDocCheckSignatureParameters ()
 Constructor. More...
 
 SignDocCheckSignatureParameters (SignDocCheckSignatureParameters aSource)
 Copy constructor. More...
 
void clear ()
 Unset all parameters. More...
 
void setBoolean (string aName, bool aValue)
 Set a boolean parameter. More...
 
void setInteger (string aName, int aValue)
 Set an integer parameter. More...
 
bool? getBoolean (string aName)
 Get the value of a boolean parameter. More...
 
int? getInteger (string aName)
 Get the value of an integer parameter. More...
 
string getErrorMessage ()
 Get an error message for the last function call. More...
 

Static Public Member Functions

static CheckSignatureParameterType getType (string aName)
 Get the type of a parameter. More...
 

Detailed Description

Parameters for SignDocSignatureData.checkReference() and SignDocSignatureData.checkSignature().

Constructor & Destructor Documentation

~SignDocCheckSignatureParameters ( )

Destructor.

!SignDocCheckSignatureParameters ( )

Finalizer.

SignDocCheckSignatureParameters ( )

Constructor.

No parameters will be set.

SignDocCheckSignatureParameters ( SignDocCheckSignatureParameters  aSource)

Copy constructor.

Parameters
[in]aSourceThe object to be copied.

Member Function Documentation

void clear ( )

Unset all parameters.

After calling this function no parameters will be set.

bool? getBoolean ( string  aName)

Get the value of a boolean parameter.

This function does not set an error message.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the specified parameter or null if the parameter is not set or is not a boolean parameter.
See also
setBoolean()
string getErrorMessage ( )

Get an error message for the last function call.

Returns
A string describing the reason for the failure of the last function call. The string is empty if the last call succeeded.
int? getInteger ( string  aName)

Get the value of an integer parameter.

This function does not set an error message.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The value of the specified parameter or null if the parameter is not set or is not an integer parameter.
See also
setInteger()
static CheckSignatureParameterType getType ( string  aName)
static

Get the type of a parameter.

Parameters
[in]aNameThe name of the parameter (case-sensitive).
Returns
The type of the parameter, see enum CheckSignatureParameterType.
void setBoolean ( string  aName,
bool  aValue 
)

Set a boolean parameter.

The following boolean parameter is available for use with SignDocSignatureData.checkReference():

  • ReferenceCheckSignatures: true to check all signatures of a reference. The default value is false.
Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getBoolean(), setInteger()
void setInteger ( string  aName,
int  aValue 
)

Set an integer parameter.

The following integer parameters are available for use with SignDocSignatureData.checkReference():

  • ReferenceMinSignatures: minimum number of signatures in a reference. Set to 0 to skip the test. The default value is 3.
  • ReferenceMinDynamicQuality (0 through 100): minimum dynamic quality of a reference (see SignDocSignatureData.getDynamicQuality()). Set to 0 to skip the test. The default value is 60.
  • ReferenceMinMStaticQuality (0 through 100): minimum static quality of a reference (see SignDocSignatureData.getStaticQuality()). Set to 0 to skip the test. The default value is 80.
  • ReferenceMaxDuration: maximum reference capture duration in seconds. Set to 0 to skip the test. The default value is 600. The reference capture duration is computed by subtracting the smallest signature timestamp of the reference from the greatest signature timestamp of the reference.

The following integer parameters will be used by SignDocSignatureData.checkReference() if the value of boolean parameter "ReferenceCheckSignatures" is true and (unconditionally) by SignDocSignatureData.checkSignature():

  • SignatureMinWidth: minimum width of a signature in mm. Set to 0 to skip the test. The default value is 10.
  • SignatureMinHeight: minimum height of a signature in mm. Set to 0 to skip the test. The default value is 5.
  • SignatureMinPressureLevels (0 through 100): minimum number of different pressure levels in a signature in percent of the pressure levels provided by the capture device or 1024 (whichever is lower). Set to 0 to skip the test. The default value is 5.
  • SignatureMinComplexity (0 through 100): minimum static quality (see SignDocSignatureData.getComplexity()). Set to 0 to skip the test. The default value is 35.
  • SignatureMinSamples: minimum number of samples with positive pressure in a signature. Set to 0 to skip the test. The default value is 10.
Note
In SignWare, ReferenceMinStaticQuality is named SPReferenceMinMatch, SignatureMinSamples is named SPSignatureMinVectors, and SignatureMinComplexity is named SPSignatureMinStaticQuality.
Parameters
[in]aNameThe name of the parameter (case-sensitive).
[in]aValueThe value of the parameter.
See also
getInteger(), setBoolean()
The documentation for this class was generated from the following file: