OfficeWorkflowRunner
OfficeIMO.Workflows
Runs bounded local conversion and PDF health workflows and publishes validated artifacts atomically.
Inheritance
- object
- OfficeWorkflowRunner
Usage
Explore 1 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 1
Constructors
public OfficeWorkflowRunner() #Creates a workflow runner without optional provenance providers.
public OfficeWorkflowRunner(IOfficeProvenanceVerifier? provenanceVerifier, IEnumerable<IOfficeProvenanceSignalDetector>? provenanceSignalDetectors = null) #Creates a workflow runner with optional cryptographic and provider-specific provenance services.
Parameters
- provenanceVerifier OfficeIMO.Provenance.IOfficeProvenanceVerifier?
- provenanceSignalDetectors System.Collections.Generic.IEnumerable<OfficeIMO.Provenance.IOfficeProvenanceSignalDetector>? = null
public OfficeWorkflowRunner(IOfficeProvenanceVerifier? provenanceVerifier, IEnumerable<IOfficeProvenanceSignalDetector>? provenanceSignalDetectors, IEnumerable<OfficeWorkflowConversionRegistration>? conversions) #Creates a runner with provenance providers and opt-in canonical conversion implementations.
Parameters
- provenanceVerifier OfficeIMO.Provenance.IOfficeProvenanceVerifier?
- provenanceSignalDetectors System.Collections.Generic.IEnumerable<OfficeIMO.Provenance.IOfficeProvenanceSignalDetector>?
- conversions System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeWorkflowConversionRegistration>?
Methods
public async Task<PdfAssemblyResult> AssemblePdfAsync(PdfAssemblyRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Normalizes supported inputs and assembles them into one validated PDF.
Parameters
- request OfficeIMO.Workflows.PdfAssemblyRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfAssemblyResult>public async Task<PdfPageImageExportResult> ExportPdfPagesAsync(PdfPageImageExportRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Exports selected PDF pages into a validated image folder.
Parameters
- request OfficeIMO.Workflows.PdfPageImageExportRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfPageImageExportResult>public static OfficeWorkflowRunner ForRegisteredConversions(IEnumerable<OfficeWorkflowConversionRegistration> conversions) #Creates a runner whose requests run only the supplied conversions.
Parameters
- conversions System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeWorkflowConversionRegistration>
Returns
OfficeWorkflowRunnerpublic async Task<PdfSearchableWorkflowResult> MakePdfSearchableAsync(PdfSearchableWorkflowRequest request, IOcrEngine engine, CancellationToken cancellationToken = default) #Recognizes an immutable source snapshot, reopens the generated PDF, and publishes after source and host checks.
Parameters
- request OfficeIMO.Workflows.PdfSearchableWorkflowRequest
- engine OfficeIMO.Ocr.IOcrEngine
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfSearchableWorkflowResult>public async Task<PdfFormOcrReview> PreparePdfFormOcrAsync(PdfDocument document, IOcrEngine engine, PdfOcrMergeOptions? options = null, OfficeOperationLimits? limits = null, CancellationToken cancellationToken = default) #Prepares a bounded, immutable review of visible values in existing form fields.
Parameters
- document OfficeIMO.Pdf.PdfDocument
- engine OfficeIMO.Ocr.IOcrEngine
- options OfficeIMO.Pdf.Ocr.PdfOcrMergeOptions? = null
- limits OfficeIMO.OfficeOperationLimits? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfFormOcrReview>public static OfficeWorkflowDocumentPreview PreviewDocument(byte[] bytes, string extension, CancellationToken cancellationToken = default) #Creates an in-memory review sample through the existing native conversion route for a supported artifact.
Parameters
- bytes byte[]
- extension string
- cancellationToken System.Threading.CancellationToken = default
public async Task<ImageOcrWorkflowResult> RecognizeImageAsync(ImageOcrWorkflowRequest request, IOcrEngine engine, CancellationToken cancellationToken = default) #Recognizes an image through Reader.Ocr, reviews the text, and publishes a verified UTF-8 artifact.
Parameters
- request OfficeIMO.Workflows.ImageOcrWorkflowRequest
- engine OfficeIMO.Ocr.IOcrEngine
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<ImageOcrWorkflowResult>public Task<OfficeWorkflowResult> RunAsync(OfficeWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs one workflow request.
Parameters
- request OfficeIMO.Workflows.OfficeWorkflowRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeWorkflowResult>public async Task<IReadOnlyList<OfficeWorkflowResult>> RunBatchAsync(IEnumerable<OfficeWorkflowRequest> requests, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs a batch sequentially so every request shares one predictable local resource budget.
Parameters
- requests System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeWorkflowRequest>
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<IReadOnlyList<OfficeWorkflowResult>>public Task<OfficeInvoiceStorageWorkflowResult> RunInvoiceAsync(OfficeInvoiceStorageWorkflowRequest request, CancellationToken cancellationToken = default) #Executes a captured invoice request through the portable runner contract.
Parameters
- request OfficeIMO.Workflows.OfficeInvoiceStorageWorkflowRequest
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeInvoiceStorageWorkflowResult>public Task<OfficeInvoiceStorageWorkflowResult> RunInvoiceAsync(OfficeInvoiceStorageWorkflowRequest request, InvoiceValidator? validator, CancellationToken cancellationToken = default) #Executes a captured invoice request with an explicit standards provider.
Parameters
- request OfficeIMO.Workflows.OfficeInvoiceStorageWorkflowRequest
- validator OfficeIMO.Invoicing.Validation.InvoiceValidator?
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeInvoiceStorageWorkflowResult>public async Task<IReadOnlyList<OfficeOcrSessionResult>> RunOcrSessionAsync(IEnumerable<OfficeOcrSessionRequest> requests, IOcrEngine engine, IProgress<OfficeWorkflowProgress>? progress = null, IProgress<OfficeOcrSessionResult>? resultsProgress = null, CancellationToken cancellationToken = default, IReadOnlyList<string>? protectedOutputPaths = null, IReadOnlyList<OfficeWorkflowProtectedSource>? protectedInputs = null) #Runs an ordered OCR session with one caller-owned engine and at most one active recognition/review.
Parameters
- requests System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeOcrSessionRequest>
- engine OfficeIMO.Ocr.IOcrEngine
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- resultsProgress System.IProgress<OfficeIMO.Workflows.OfficeOcrSessionResult>? = null
- cancellationToken System.Threading.CancellationToken = default
- protectedOutputPaths System.Collections.Generic.IReadOnlyList<string>? = null
- protectedInputs System.Collections.Generic.IReadOnlyList<OfficeIMO.Workflows.OfficeWorkflowProtectedSource>? = null
Returns
Task<IReadOnlyList<OfficeOcrSessionResult>>public async Task<OfficeProvenanceWorkflowResult> RunProvenanceAsync(OfficeProvenanceWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs one provenance request with bounded input and atomic removal publication.
Parameters
- request OfficeIMO.Workflows.OfficeProvenanceWorkflowRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<OfficeProvenanceWorkflowResult>public async Task<IReadOnlyList<OfficeProvenanceWorkflowResult>> RunProvenanceBatchAsync(IEnumerable<OfficeProvenanceWorkflowRequest> requests, OfficeProvenanceWorkflowBatchOptions? options = null, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs a bounded batch sequentially so providers and parsers share one predictable resource envelope.
Parameters
- requests System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeProvenanceWorkflowRequest>
- options OfficeIMO.Workflows.OfficeProvenanceWorkflowBatchOptions? = null
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<IReadOnlyList<OfficeProvenanceWorkflowResult>>public async Task<PdfRedactionWorkflowResult> RunRedactionAsync(PdfRedactionWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Plans, applies, or verifies one PDF redaction workflow.
Parameters
- request OfficeIMO.Workflows.PdfRedactionWorkflowRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfRedactionWorkflowResult>public async Task<PdfRedactionBatchResult> RunRedactionBatchAsync(PdfRedactionBatchRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Resolves and runs a deterministic file-set batch.
Parameters
- request OfficeIMO.Workflows.PdfRedactionBatchRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfRedactionBatchResult>public async Task<PdfRedactionBatchResult> RunRedactionBatchAsync(IEnumerable<PdfRedactionWorkflowRequest> requests, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Runs a bounded all-or-nothing publication batch.
Parameters
- requests System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.PdfRedactionWorkflowRequest>
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfRedactionBatchResult>public async Task<PdfSplitWorkflowResult> SplitPdfAsync(PdfSplitWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #Splits consecutive pages through the PDF engine and publishes reopened, bounded outputs.
Parameters
- request OfficeIMO.Workflows.PdfSplitWorkflowRequest
- progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<PdfSplitWorkflowResult>Inherited Methods
Properties
public IReadOnlyList<OfficeWorkflowRoute> ConversionRoutes { get; } #Executable routes for this configured runner, including opt-in registrations.
Fields
public const int MaximumBatchRequestCount #Maximum number of requests accepted by one sequential batch.
250