Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Interface

IOfficeWorkflowRunner

OfficeIMO.Workflows

Namespace
OfficeIMO.Workflows
Assembly
OfficeIMO.Workflows
Source revision
ba882f6b0d07 with working tree changes
Modifiers
abstract

Runs typed local OfficeIMO document workflows for desktop, command-line, and service hosts.

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.

Accepted by parameters 1

Methods

public abstract Task<OfficeWorkflowResult> RunAsync(OfficeWorkflowRequest request, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #

Runs one workflow request.

Parameters

request OfficeIMO.Workflows.OfficeWorkflowRequest required
progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public abstract Task<IReadOnlyList<OfficeWorkflowResult>> RunBatchAsync(IEnumerable<OfficeWorkflowRequest> requests, IProgress<OfficeWorkflowProgress>? progress = null, CancellationToken cancellationToken = default) #

Snapshots and runs a bounded batch sequentially. Implementations reject more than OfficeWorkflowRunner.MaximumBatchRequestCount requests.

Parameters

requests System.Collections.Generic.IEnumerable<OfficeIMO.Workflows.OfficeWorkflowRequest> required
progress System.IProgress<OfficeIMO.Workflows.OfficeWorkflowProgress>? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

Task<IReadOnlyList<OfficeWorkflowResult>>

Properties

public virtual IReadOnlyList<OfficeWorkflowRoute> ConversionRoutes { get; } #

Executable routes of this runner. Implementations with opt-in adapters override this view.