Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Interface

IOfficeWorkflowRunner

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Modifiers abstract

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

Usage

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

Accepted by parameters

Methods

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

Runs one workflow request.

Parameters

request OfficeIMO.Workflows.OfficeWorkflowRequest requiredposition: 0
progress System.IProgress{OfficeIMO.Workflows.OfficeWorkflowProgress} = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2
public abstract Task<IReadOnlyList<OfficeWorkflowResult>> RunBatchAsync(IEnumerable<OfficeWorkflowRequest> requests, IProgress<OfficeWorkflowProgress> progress = null, CancellationToken cancellationToken = default) #
Returns: Task<IReadOnlyList<OfficeWorkflowResult>>

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

Parameters

requests System.Collections.Generic.IEnumerable{OfficeIMO.Workflows.OfficeWorkflowRequest} requiredposition: 0
progress System.IProgress{OfficeIMO.Workflows.OfficeWorkflowProgress} = null optionalposition: 1
cancellationToken System.Threading.CancellationToken = default optionalposition: 2