Get Started

API Reference

Class

PdfExternalValidationResult

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:8
Modifiers sealed

Result from a caller- or CI-run external PDF compliance validator.

Inheritance

  • Object
  • PdfExternalValidationResult

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

public PdfExternalValidationResult(PdfExternalValidatorKind validatorKind, PdfExternalValidationStatus status, String validatorName, String diagnostic, String profile = null, String executablePath = null, String arguments = null, Nullable<Int32> exitCode = null, String validatorVersion = null, String artifactSha256 = null, Nullable<Int64> artifactSizeBytes = null, Nullable<DateTimeOffset> validatedAtUtc = null, IEnumerable<String> warnings = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:8

Creates an external validation result.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
status OfficeIMO.Pdf.PdfExternalValidationStatus requiredposition: 1
validatorName System.String requiredposition: 2
diagnostic System.String requiredposition: 3
profile System.String = null optionalposition: 4
executablePath System.String = null optionalposition: 5
arguments System.String = null optionalposition: 6
exitCode System.Nullable{System.Int32} = null optionalposition: 7
validatorVersion System.String = null optionalposition: 8
artifactSha256 System.String = null optionalposition: 9
artifactSizeBytes System.Nullable{System.Int64} = null optionalposition: 10
validatedAtUtc System.Nullable{System.DateTimeOffset} = null optionalposition: 11
warnings System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 12

Methods

public static PdfExternalValidationResult Error(PdfExternalValidatorKind validatorKind, String validatorName, String diagnostic, String profile = null, Nullable<Int32> exitCode = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:156
Returns: PdfExternalValidationResult

Creates a validator error result.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
diagnostic System.String requiredposition: 2
profile System.String = null optionalposition: 3
exitCode System.Nullable{System.Int32} = null optionalposition: 4
public static PdfExternalValidationResult Failed(PdfExternalValidatorKind validatorKind, String validatorName, String diagnostic, String profile = null, Nullable<Int32> exitCode = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:124
Returns: PdfExternalValidationResult

Creates a failing validator result.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
diagnostic System.String requiredposition: 2
profile System.String = null optionalposition: 3
exitCode System.Nullable{System.Int32} = null optionalposition: 4
public static PdfExternalValidationResult FromExitCode(PdfExternalValidatorKind validatorKind, Int32 exitCode, String validatorName, String diagnostic, String profile = null, String executablePath = null, String arguments = null, Int32 successExitCode = 0) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:168
Returns: PdfExternalValidationResult

Creates a validator result from a process exit code, treating the configured success code as Passed and all other codes as Failed.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
exitCode System.Int32 requiredposition: 1
validatorName System.String requiredposition: 2
diagnostic System.String requiredposition: 3
profile System.String = null optionalposition: 4
executablePath System.String = null optionalposition: 5
arguments System.String = null optionalposition: 6
successExitCode System.Int32 = 0 optionalposition: 7
public static PdfExternalValidationResult FromExitCodeForArtifact(PdfExternalValidatorKind validatorKind, Int32 exitCode, String validatorName, String validatorVersion, String diagnostic, Byte[] artifact, String profile = null, String executablePath = null, String arguments = null, Int32 successExitCode = 0, IEnumerable<String> warnings = null, Nullable<DateTimeOffset> validatedAtUtc = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:192
Returns: PdfExternalValidationResult

Creates an exit-code result bound to the exact supplied PDF bytes.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
exitCode System.Int32 requiredposition: 1
validatorName System.String requiredposition: 2
validatorVersion System.String requiredposition: 3
diagnostic System.String requiredposition: 4
artifact System.Byte[] requiredposition: 5
profile System.String = null optionalposition: 6
executablePath System.String = null optionalposition: 7
arguments System.String = null optionalposition: 8
successExitCode System.Int32 = 0 optionalposition: 9
warnings System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 10
validatedAtUtc System.Nullable{System.DateTimeOffset} = null optionalposition: 11
public static PdfExternalValidationResult NotRun(PdfExternalValidatorKind validatorKind, String validatorName, String diagnostic, String profile = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:128
Returns: PdfExternalValidationResult

Creates a not-run validator result.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
diagnostic System.String requiredposition: 2
profile System.String = null optionalposition: 3
public static PdfExternalValidationResult NotRunForArtifact(PdfExternalValidatorKind validatorKind, String validatorName, String validatorVersion, String diagnostic, Byte[] artifact, String profile = null, IEnumerable<String> warnings = null, Nullable<DateTimeOffset> recordedAtUtc = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:140
Returns: PdfExternalValidationResult

Creates a not-run result associated with an intended exact PDF artifact.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
validatorVersion System.String requiredposition: 2
diagnostic System.String requiredposition: 3
artifact System.Byte[] requiredposition: 4
profile System.String = null optionalposition: 5
warnings System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 6
recordedAtUtc System.Nullable{System.DateTimeOffset} = null optionalposition: 7
public static PdfExternalValidationResult Passed(PdfExternalValidatorKind validatorKind, String validatorName, String diagnostic, String profile = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:90
Returns: PdfExternalValidationResult

Creates a passing validator result.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
diagnostic System.String requiredposition: 2
profile System.String = null optionalposition: 3
public static PdfExternalValidationResult PassedForArtifact(PdfExternalValidatorKind validatorKind, String validatorName, String validatorVersion, String diagnostic, Byte[] artifact, String profile = null, IEnumerable<String> warnings = null, String executablePath = null, String arguments = null, Nullable<Int32> exitCode = 0, Nullable<DateTimeOffset> validatedAtUtc = null) #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:105
Returns: PdfExternalValidationResult

Creates a passing result bound to the exact supplied PDF bytes.

Parameters

validatorKind OfficeIMO.Pdf.PdfExternalValidatorKind requiredposition: 0
validatorName System.String requiredposition: 1
validatorVersion System.String requiredposition: 2
diagnostic System.String requiredposition: 3
artifact System.Byte[] requiredposition: 4
profile System.String = null optionalposition: 5
warnings System.Collections.Generic.IEnumerable{System.String} = null optionalposition: 6
executablePath System.String = null optionalposition: 7
arguments System.String = null optionalposition: 8
exitCode System.Nullable{System.Int32} = 0 optionalposition: 9
validatedAtUtc System.Nullable{System.DateTimeOffset} = null optionalposition: 10

Properties

public PdfExternalValidatorKind ValidatorKind { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:47

Validator family.

public PdfExternalValidationStatus Status { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:50

Validation outcome.

public String ValidatorName { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:53

Human-readable validator name, for example veraPDF or Mustang.

public String Diagnostic { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:56

Human-readable result details from the caller or validator.

public String Profile { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:59

Optional profile string used by the external tool.

public String ExecutablePath { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:62

Optional executable path used by CI or wrapper tooling.

public String Arguments { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:65

Optional command-line arguments used by CI or wrapper tooling.

public Nullable<Int32> ExitCode { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:68

Optional process exit code reported by CI or wrapper tooling.

public String ValidatorVersion { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:71

Validator version reported by the proof runner.

public String ArtifactSha256 { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:74

Lowercase SHA-256 of the exact PDF bytes supplied to the validator.

public Nullable<Int64> ArtifactSizeBytes { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:77

Size of the exact validated PDF artifact, in bytes.

public Nullable<DateTimeOffset> ValidatedAtUtc { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:80

UTC timestamp recorded by the proof runner after validation.

public IReadOnlyList<String> Warnings { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:83

Warnings reported by the validator or proof runner.

public Boolean HasArtifactBinding { get; } #
OfficeIMO.Pdf/Compliance/PdfExternalValidationResult.cs:86

True when this result identifies an exact PDF artifact by SHA-256 and byte length.