Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeWorkflowStreamOutput

OfficeIMO.Workflows

Namespace
OfficeIMO.Workflows
Assembly
OfficeIMO.Workflows
Source revision
ba882f6b0d07 with working tree changes
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

Explore 7 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

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 string required
openRead System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<System.IO.Stream>> required
openWrite System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<System.IO.Stream>> required
recoveryStore OfficeIMO.Workflows.OfficeWorkflowOutputRecoveryStore required
prepareDestination System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<string>>? = null optional

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.