PSPDFSignatureInfo

Objective-C


@interface PSPDFSignatureInfo : NSObject

Swift

class PDFSignatureInfo : NSObject

Signature info for signature form fields.

See

PSPDFSignatureFormElement, PSPDFSigner

See

ISO 32000-2:2017(E) Table 255 — Entries in a signature dictionary

  • Specifies how many placeholder bytes will be reserved for the signature.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSUInteger placeholderBytes;

    Swift

    var placeholderBytes: UInt { get }

  • The signature value as data.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSData *contents;

    Swift

    var contents: Data? { get }

  • Deprecated

    Deprecated in PSPDFKit 12.1 for iOS. Use byteRanges instead.

    The ranges of the bytes of data being signed.

    This property is deprecated in favor of byteRanges.

    An array of pairs of integers (wrapped as NSNumber, starting byte offset, length in bytes) that shall describe the exact byte range for the digest calculation. Multiple discontiguous byte ranges shall be used to describe a digest that does not include the signature value (the Contents entry) itself. If SubFilter is ETSI.CAdES.detached, the ByteRange shall cover the entire file, including the signature dictionary but excluding the Contents value.

    Declaration

    Objective-C

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

  • The ranges of the bytes of data being signed.

    The exact byte ranges for the digest calculation. Multiple discontiguous byte ranges shall be used to describe a digest that does not include the signature value (the Contents entry) itself. If SubFilter is ETSI.CAdES.detached, the ByteRange shall cover the entire file, including the signature dictionary but excluding the Contents value.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSIndexSet *byteRanges;

    Swift

    var byteRanges: IndexSet? { get }

  • The PDF filter name to use for this signer. Typical values are Adobe.PPKLite, Entrust.PPKEF, CICI.SignIt, and VeriSign.PPKVS. Returns Adobe.PPKLite as default value, as it’s the only value supported for now.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *filter;

    Swift

    var filter: String? { get }

  • The PDF SubFilter entry value. Tied to signatureType. Typical values are ETSI.CAdES.detached, adbe.pkcs7.detached, and adbe.pkcs7.sha1.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *subFilter;

    Swift

    var subFilter: String? { get }

  • The name.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *name;

    Swift

    var name: String? { get }

  • The creation date of the signature.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSDate *creationDate;

    Swift

    var creationDate: Date? { get }

  • The place where this signature was created. For example, ‘Vienna’.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *location;

    Swift

    var location: String? { get }

  • The reason that will be embedded in every digital signature created by this instance of PSPDFSigner. For example, if you are signing a PDF contract you can set this property to I agree with the terms of this contract.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *reason;

    Swift

    var reason: String? { get }

  • The build properties of the signature.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) PSPDFSignaturePropBuild *propBuild;

    Swift

    @NSCopying var propBuild: PSPDFSignaturePropBuild? { get }

  • (Optional; PDF 1.5) An array of signature reference dictionaries.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSArray<PSPDFDigitalSignatureReference *> *references;

    Swift

    var references: [PSPDFDigitalSignatureReference]? { get }

  • The ranges of the bytes of data being signed.

    This property is deprecated in favor of byteRanges.

    An array of ranges (starting byte offset, length in bytes) that shall describe the exact byte range for the digest calculation. Multiple discontiguous byte ranges shall be used to describe a digest that does not include the signature value (the Contents entry) itself. If SubFilter is ETSI.CAdES.detached, the ByteRange shall cover the entire file, including the signature dictionary but excluding the Contents value.

    Declaration

    Swift

    @available(*, deprecated, message: "Deprecated in PSPDFKit 12.1 for iOS. Use `byteRanges` instead.")
public var byteRange: [Range<UInt64>]? { get }