Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeWorkflowStreamOutput

Namespace OfficeIMO.Workflows
Assembly OfficeIMO.Workflows
Modifiers sealed

A user-selected provider destination with verified direct writes and durable recovery.

Inheritance

  • Object
  • OfficeWorkflowStreamOutput

Remarks

Only Replace is supported. A provider cannot guarantee atomic replacement, exclusive creation, or rollback.

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 OfficeWorkflowStreamOutput(String name, Func<CancellationToken, Task<Stream>> openRead, Func<CancellationToken, Task<Stream>> openWrite, OfficeWorkflowOutputRecoveryStore recoveryStore, Func<CancellationToken, Task<String>> prepareDestination = null) #

Creates a destination. The host must explain and obtain consent for direct provider writes.

Parameters

name System.String requiredposition: 0
openRead System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.IO.Stream}} requiredposition: 1
openWrite System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.IO.Stream}} requiredposition: 2
recoveryStore OfficeIMO.Workflows.OfficeWorkflowOutputRecoveryStore requiredposition: 3
prepareDestination System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.String}} = null optionalposition: 4

Properties

public String Name { get; } #

Gets the selected filename, including its output format extension.

public Func<CancellationToken, Task<Stream>> OpenRead { get; } #

Gets the factory used to establish local provider access and verify committed contents after closing the write stream.

public Func<CancellationToken, Task<Stream>> OpenWrite { get; } #

Gets the factory that opens a destructive write stream. The runner closes every returned stream.

public OfficeWorkflowOutputRecoveryStore RecoveryStore { get; } #

Gets the durable store used before any destination write begins.

public Func<CancellationToken, Task<String>> PrepareDestination { get; } #

Gets optional deferred creation for a new provider child, returning its actual location.