PSPDFSignatureBiometricProperties


@interface PSPDFSignatureBiometricProperties : NSObject <NSSecureCoding>

An instance of PSPDFSignatureBiometricProperties represents properties which add biometric information to a digital signature, for enhanced security. Biometric information includes the input method pressure values, time intervals when the signature was being created, or average touch radius. This information is encrypted and stored inside the PDF document using the signer’s public key, and can be decrypted with the appropriate private key.

  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFSignatureBiometricProperties : NSObject <NSSecureCoding>
  • Undocumented

    Declaration

    Objective-C

    
    @interface PSPDFSignatureBiometricProperties : NSObject <NSSecureCoding>
  • Initializes a new PSPDFSignatureBiometricProperties.

    Note

    There can only be a maximum of 6 values in the pressureList and timePointsList arrays combined.

    Declaration

    Objective-C

    - (nullable instancetype)
    initWithPressureList:(nullable NSArray<NSNumber *> *)pressureList
          timePointsList:(nullable NSArray<NSNumber *> *)timePointsList
             touchRadius:(nullable NSNumber *)touchRadius
             inputMethod:(PSPDFSignatureInputMethod)inputMethod;

    Swift

    init?(pressureList: [NSNumber]?, timePointsList: [NSNumber]?, touchRadius: NSNumber?, inputMethod: PSPDFSignatureInputMethod)

    Parameters

    pressureList

    A list of physical pressures obtained when the user signed the document.

    timePointsList

    A list of time intervals obtained from specific points in a handwritten signature.

    touchRadius

    The average touch radius used to create this signature.

    inputMethod

    The input method used to create the signature (ie. finger, Apple Pencil, etc.)

  • The list of pressure values that were recorded when the signature was created.

    When signing a document with the default UI, this is set to the first, the middle and the last floating point intensity values of the created ink signature. If inputMethod is set to PSPDFSignatureInputMethodFinger, this is calculated based on the velocity of the drawing. If inputMethod is set to PSPDFSignatureInputMethodApplePencil, this is calculated based on the Apple Pencil’s azimuth and altitude towards the display. If inputMethod is set to PSPDFSignatureInputMethodThirdPartyStylus, this is calculated using the corresponding stylus driver.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSArray<NSNumber *> *pressureList;

    Swift

    var pressureList: [NSNumber]? { get }
  • The list of time point values that were recorded when the signature was created.

    When signing a document with the default UI, this is set to an array of the first, the middle and the last time stamps during the creation of the ink signature. The time stamps are corresponding to the values in pressureList and have been taken at the same point in time.

    Note

    Includes boxed NSTimeInterval values, set to -[NSDate timeIntervalSince1970] at the time of the drawing.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSArray<NSNumber *> *timePointsList;

    Swift

    var timePointsList: [NSNumber]? { get }
  • The average touch radius that was recorded when the signature was created.

    When signing a document with the default UI, and inputMethod is set to PSPDFSignatureInputMethodFinger or PSPDFSignatureInputMethodThirdPartyStylus this is set to the average radius of all touches of the created ink annotation. If inputMethod is set to PSPDFSignatureInputMethodApplePencil, the altitude angle of the Apple Pencil is used instead.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable) NSNumber *touchRadius;

    Swift

    var touchRadius: NSNumber? { get }
  • The device that was used to create the signature.

    When signing a document with the default UI, this is set to the last used input method of the created ink signature.

    Declaration

    Objective-C

    @property (readonly, nonatomic) PSPDFSignatureInputMethod inputMethod;

    Swift

    var inputMethod: PSPDFSignatureInputMethod { get }