Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeWorkflowProgress

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Modifiers sealed

Progress update for one workflow request.

Inheritance

  • Object
  • OfficeWorkflowProgress

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 OfficeWorkflowProgress(String requestId, String stage, String message, Double fraction, Nullable<Double> overallFraction = null) #

Creates a progress update.

Parameters

requestId System.String requiredposition: 0
stage System.String requiredposition: 1
message System.String requiredposition: 2
fraction System.Double requiredposition: 3
overallFraction System.Nullable{System.Double} = null optionalposition: 4

Properties

public String RequestId { get; } #

Caller-provided request identifier.

public String Stage { get; } #

Stable execution stage.

public String Message { get; } #

User-facing progress message.

public Double Fraction { get; } #

Normalized completion fraction.

public Double OverallFraction { get; } #

Normalized overall batch fraction, equal to Fraction for a single request.