Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeWorkflowStreamInput

OfficeIMO.Workflows

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

A reopenable provider input whose original location remains in the workflow request.

Inheritance

  • object
  • OfficeWorkflowStreamInput

Usage

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

Constructors

OfficeWorkflowStreamInput 3 overloads
public OfficeWorkflowStreamInput(string name, Func<CancellationToken, Task<Stream>> openRead, string? expectedSha256 = null) #

Creates a byte-stream input; existing overload remains binary compatible.

Parameters

name string required
openRead System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<System.IO.Stream>> required
expectedSha256 string? = null optional
public OfficeWorkflowStreamInput(string name, Func<CancellationToken, Task<Stream>> openRead, string? expectedSha256, OfficeWorkflowSourceSnapshotKind snapshotKind) #

Creates an input. Each invocation must return a new readable stream; the runner closes it.

Parameters

name string required
The provider's display filename, including its format extension.
openRead System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<System.IO.Stream>> required
Opens the selected document with the provider's permission scope.
expectedSha256 string? required
Optional hexadecimal SHA-256 captured when the input was selected.
snapshotKind OfficeIMO.Workflows.OfficeWorkflowSourceSnapshotKind required
Meaning of the captured byte checksum.
public OfficeWorkflowStreamInput(string name, Func<CancellationToken, Task<Stream>> openRead, string? expectedSha256, OfficeWorkflowSourceSnapshotKind snapshotKind, IOfficePublicationGuard? sourcePublicationGuard) #

Creates a snapshot input with an owning package's output-separation guard.

Parameters

name string required
openRead System.Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<System.IO.Stream>> required
expectedSha256 string? required
snapshotKind OfficeIMO.Workflows.OfficeWorkflowSourceSnapshotKind required
sourcePublicationGuard OfficeIMO.IOfficePublicationGuard? required

Properties

public string Name { get; } #

Gets the selected filename. This name determines format routing, never a staging directory.

public OfficeWorkflowSourceSnapshotKind SnapshotKind { get; } #

Meaning of the captured byte checksum. Directory package checksums describe their private transport snapshot.

public IOfficePublicationGuard? SourcePublicationGuard { get; } #

Optional owner guard that keeps publication separate from all members of a package.

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

Gets the stream factory; the runner invokes it again to verify source contents before publication.

public string? ExpectedSha256 { get; } #

Gets the optional fingerprint captured when the input was selected.