PTVerificationResult

@interface PTVerificationResult : NSObject

Retrieves the main verification status. The main status is determined based on the other statuses. Verification may fail for many reasons; some of these reasons are the presence of features that are not supported yet. It may be desirable for you to report unsupported signatures differently (for example, using a question mark rather than an X mark). Any unsupported features encountered can be retrieved by the use of the function GetUnsupportedFeatures on this class.

  • Undocumented

    Declaration

    Objective-C

    - (BOOL)GetVerificationStatus;

    Swift

    func getVerificationStatus() -> Bool

  • Retrieves the document-related result condition associated with a digital signature verification operation.

    Declaration

    Objective-C

    - (PTVerificationResultDocumentStatus)GetDocumentStatus;

    Swift

    func getDocumentStatus() -> PTVerificationResultDocumentStatus

    Return Value

    A DocumentStatus-type enumeration value.

  • Retrieves the digest-related result condition associated with a digital signature verification operation.

    Declaration

    Objective-C

    - (PTVerificationResultDigestStatus)GetDigestStatus;

    Swift

    func getDigestStatus() -> PTVerificationResultDigestStatus

    Return Value

    A DigestStatus-type enumeration value.

  • Retrieves the trust-related result condition associated with a digital signature verification operation.

    Declaration

    Objective-C

    - (PTVerificationResultTrustStatus)GetTrustStatus;

    Swift

    func getTrustStatus() -> PTVerificationResultTrustStatus

    Return Value

    A TrustStatus-type enumeration value.

  • Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation.

    Declaration

    Objective-C

    - (PTVerificationResultModificationPermissionsStatus)GetPermissionsStatus;

    Swift

    func getPermissionsStatus() -> PTVerificationResultModificationPermissionsStatus

    Return Value

    A ModificationPermissionsStatus-type enumeration value.

  • Returns whether there is a detailed TrustVerificationResult in this VerificationResult or not.

    Declaration

    Objective-C

    - (BOOL)HasTrustVerificationResult;

    Swift

    func hasTrust() -> Bool

    Return Value

    A boolean.

  • Retrieves the detailed result associated with the trust step of the verification operation that returned this VerificationResult, if such a detailed trust result is available. Must call HasTrustVerificationResult first and check for a true result.

    Note

    This function will throw if no TrustVerificationResult is available.

    Declaration

    Objective-C

    - (PTTrustVerificationResult *)GetTrustVerificationResult;

    Swift

    func getTrust() -> PTTrustVerificationResult!

    Return Value

    a TrustVerificationResult object

  • Retrieves a list of informational structures regarding any disallowed changes that have been made to the document since the signature associated with this verification result was signed.

    Declaration

    Objective-C

    - (NSArray<PTDisallowedChange *> *)GetDisallowedChanges;

    Swift

    func getDisallowedChanges() -> [PTDisallowedChange]!

    Return Value

    a collection of DisallowedChange objects.

  • Retrieves an enumeration value representing the digest algorithm used to sign the signature that is associated with this verification result. For DocTimeStamp signatures, returns the weakest algorithm found (between the CMS and message imprint digests).

    Declaration

    Objective-C

    - (PTDigestAlgorithmType)GetDigestAlgorithm;

    Swift

    func getDigestAlgorithm() -> PTDigestAlgorithmType

    Return Value

    A DigestAlgorithm enumeration value.

  • Retrieves the document-related result condition associated with a digital signature verification operation, as a descriptive string.

    Declaration

    Objective-C

    - (NSString *)GetDocumentStatusAsString;

    Swift

    func getDocumentStatusAsString() -> String!

    Return Value

    a string.

  • Retrieves the digest-related result condition associated with a digital signature verification operation, as a descriptive string.

    Declaration

    Objective-C

    - (NSString *)GetDigestStatusAsString;

    Swift

    func getDigestStatusAsString() -> String!

    Return Value

    a string.

  • Retrieves the trust-related result condition associated with a digital signature verification operation, as a descriptive string.

    Declaration

    Objective-C

    - (NSString *)GetTrustStatusAsString;

    Swift

    func getTrustStatusAsString() -> String!

    Return Value

    a string.

  • Retrieves the result condition about permissions checks performed on any unsigned modifications associated with a digital signature verification operation, as a descriptive string.

    Declaration

    Objective-C

    - (NSString *)GetPermissionsStatusAsString;

    Swift

    func getPermissionsStatusAsString() -> String!

    Return Value

    a string.

  • Retrieves reports about unsupported features encountered during verification. This function is the canonical source of information about all unsupported features encountered. Current possible values: “unsupported signature encoding”, “usage rights signature”, “legal content attestations”, “unsupported digest algorithm”

    Note

    Output may change in future versions.

    Declaration

    Objective-C

    - (NSArray<NSString *> *)GetUnsupportedFeatures;

    Swift

    func getUnsupportedFeatures() -> [String]!

    Return Value

    a container of strings representing unsupported features encountered during verification

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()