Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfRedactionBatchRequest

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Modifiers sealed

Serializable, deterministic file-set request for a PDF redaction batch.

Inheritance

  • Object
  • PdfRedactionBatchRequest

Usage

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

Accepted by parameters

Constructors

public PdfRedactionBatchRequest() #
Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)

Properties

public String Schema { get; set; } #

Schema identifier.

public PdfRedactionWorkflowMode Mode { get; set; } #

Workflow mode applied to every selected input.

public String InputRoot { get; set; } #

Root containing reviewed source PDFs.

public IList<String> InputPaths { get; set; } #

Optional relative input paths. When empty, SearchPattern is enumerated beneath InputRoot.

public String SearchPattern { get; set; } #

File-system search pattern used when InputPaths is empty. Defaults to *.pdf.

public Boolean RecurseSubdirectories { get; set; } #

Whether pattern discovery recurses beneath the input root.

public String OutputRoot { get; set; } #

Separate root for redacted outputs or existing outputs being verified.

public String EvidenceRoot { get; set; } #

Separate root for privacy-safe per-item evidence.

public String DecisionsRoot { get; set; } #

Separate root containing reviewed decision manifests for apply and verify modes.

public String OutputSuffix { get; set; } #

Suffix appended to each input stem for output PDFs.

public String EvidenceSuffix { get; set; } #

Suffix appended to each input stem for per-item evidence.

public String DecisionsSuffix { get; set; } #

Suffix appended to each input stem when resolving reviewed decisions.

public String ManifestPath { get; set; } #

Consolidated privacy-safe batch manifest path.

public PdfRedactionBatchPublicationPolicy PublicationPolicy { get; set; } #

Publication behavior for item failures.

public OfficeWorkflowConflictPolicy ConflictPolicy { get; set; } #

Output conflict behavior shared by the batch.

public PdfRedactionRecipe Recipe { get; set; } #

Named redaction recipe shared by the batch.

public PdfRedactionWorkflowLimits Limits { get; set; } #

Shared resource limits.

public IList<String> ProtectedInputPaths { get; set; } #
JsonIgnore

Additional host inputs that publication may not replace.

public IOcrEngine OcrEngine { get; set; } #
JsonIgnore

Runtime OCR engine; never serialized.

public PdfOcrMergeOptions OcrOptions { get; set; } #
JsonIgnore

Runtime OCR options; never serialized.

public String OwnerPassword { get; set; } #
JsonIgnore

Runtime owner password; never serialized.

public PdfStandardEncryptionOptions OutputEncryption { get; set; } #
JsonIgnore

Runtime output encryption; passwords are never serialized.

public IPdfExternalSigner OutputSigner { get; set; } #
JsonIgnore

Runtime signer for signed derivatives; never serialized.

public PdfExternalSignatureOptions OutputSignatureOptions { get; set; } #
JsonIgnore

Runtime signature options; never serialized.

public IPdfSignatureCryptographyProvider OutputSignatureValidator { get; set; } #
JsonIgnore

Runtime signature validator; never serialized.

public IList<IPdfRedactionCancellationAwareExternalValidator> ExternalValidators { get; set; } #
JsonIgnore

Runtime validators; never serialized.

Fields

public const String CurrentSchema #

Stable request schema.

Value: officeimo.pdf.redaction.batch-request.v1