API Reference
OfficeWorkflowRequest
One typed local workflow request.
Inheritance
- Object
- OfficeWorkflowRequest
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
- Method OfficeWorkflowBuilder.Build
Accepted by parameters
- Method IOfficeWorkflowRunner.RunAsync
- Method IOfficeWorkflowRunner.RunBatchAsync
- Method OfficeWorkflow.RunAsync
- Method OfficeWorkflowRunner.RunAsync
- Method OfficeWorkflowRunner.RunBatchAsync
Constructors
public OfficeWorkflowRequest() #Obsolete("Constructors of types with required members are not supported in this version of your compiler.", true)Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Id { get; set; } #Caller-provided request identifier used by progress and batch results.
public OfficeWorkflowOperation Operation { get; set; } #Requested operation.
public String InputPath { get; set; } #Primary input file.
public OfficeWorkflowStreamInput InputStream { get; set; } #Optional provider access for InputPath. The path remains the original location or absolute URI.
public Int32[] PageNumbers { get; set; } #Ordered one-based pages for ExtractPages, including intentional repeats. Limited to 100,000 entries.
public String ComparisonPath { get; set; } #Comparison input used by Compare.
public OfficeWorkflowStreamInput ComparisonStream { get; set; } #Optional provider access for ComparisonPath.
public String ConversionRouteId { get; set; } #Conversion route identifier from OfficeWorkflowCatalog.
public OfficeWorkflowConversionOptions ConversionOptions { get; set; } #Optional route-specific settings, independently copied and validated before asynchronous execution.
public OfficeScanCleanupOptions ScanCleanup { get; set; } #Explicit scan preparation and raster-output acknowledgement for ScanCleanup.
public String OutputPath { get; set; } #Requested output file. Inspect does not require one; compare emits HTML when one is supplied.
public OfficeWorkflowStreamOutput OutputStream { get; set; } #Optional verified direct-write access for the original OutputPath provider location.
public OfficeWorkflowConflictPolicy ConflictPolicy { get; set; } #Conflict behavior used when publishing an artifact.
public IOfficeWorkflowPublicationGuard PublicationGuard { get; set; } #Optional live application ownership check for final publication candidates.
public OfficeWorkflowOutputProfile OutputProfile { get; set; } #Cross-format output intent.
public String PdfPassword { get; set; } #Optional PDF password. It is used only while executing and is never copied to results or reports.
public String ComparisonPdfPassword { get; set; } #Optional password for the comparison PDF. When omitted, PdfPassword is reused. It is used only while executing and is never copied to results or reports.
public PdfStandardEncryptionOptions OutputEncryption { get; set; } #New password protection for ProtectPdf. Cloned before execution; credentials remain request-only.
public String PdfOwnerPassword { get; set; } #Current owner password for replacing or removing protection. Falls back to PdfPassword when omitted.
public IPdfExternalSigner OutputSigner { get; set; } #Runtime signer for SignPdf. The caller retains ownership and must keep it alive until execution completes.
public PdfExternalSignatureOptions OutputSignatureOptions { get; set; } #Signature and appearance settings for SignPdf, copied before asynchronous execution.
public IPdfSignatureCryptographyProvider OutputSignatureValidator { get; set; } #Required runtime cryptographic verifier for SignPdf. Chain trust is reported independently from signature math.
public OfficeWorkflowLimits Limits { get; set; } #Shared request resource limits.