# OfficeWorkflowStreamInput

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

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeWorkflowStreamInput.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L8)

**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.

### Returned or exposed by 10

- Property [ImageOcrWorkflowRequest.InputStream](/api/workflows/officeimo-workflows-imageocrworkflowrequest/#property-inputstream)
- Property [OfficeInvoiceStorageWorkflowRequest.InputStream](/api/workflows/officeimo-workflows-officeinvoicestorageworkflowrequest/#property-inputstream)
- Property [OfficeWorkflowDirectoryEntry.Input](/api/workflows/officeimo-workflows-officeworkflowdirectoryentry/#property-input)
- Property [OfficeWorkflowProtectedSource.InputStream](/api/workflows/officeimo-workflows-officeworkflowprotectedsource/#property-inputstream)
- Property [OfficeWorkflowRequest.ComparisonStream](/api/workflows/officeimo-workflows-officeworkflowrequest/#property-comparisonstream)
- Property [OfficeWorkflowRequest.InputStream](/api/workflows/officeimo-workflows-officeworkflowrequest/#property-inputstream)
- Property [PdfAssemblyRequest.SourceStreams](/api/workflows/officeimo-workflows-pdfassemblyrequest/#property-sourcestreams)
- Property [PdfPageImageExportRequest.InputStream](/api/workflows/officeimo-workflows-pdfpageimageexportrequest/#property-inputstream)
- Property [PdfSearchableWorkflowRequest.InputStream](/api/workflows/officeimo-workflows-pdfsearchableworkflowrequest/#property-inputstream)
- Property [PdfSplitWorkflowRequest.InputStream](/api/workflows/officeimo-workflows-pdfsplitworkflowrequest/#property-inputstream)

### Accepted by parameters 4

- Method [OfficeWorkflowConversionRegistration.Create``1](/api/workflows/officeimo-workflows-officeworkflowconversionregistration/#method-create-string-officeimo-workflows-officeworkflowconfiguredconverter-func-system-string-officeimo-officeoperationlimits-officeimo-workflows-officeworkflowstreaminput) parameter `directoryPackageInput`
- Constructor [OfficeWorkflowDirectoryEntry.OfficeWorkflowDirectoryEntry](/api/workflows/officeimo-workflows-officeworkflowdirectoryentry/#constructor-ctor-string-string-officeimo-workflows-officeworkflowstreaminput) parameter `Input`
- Method [OfficeWorkflowDirectoryEntry.Deconstruct](/api/workflows/officeimo-workflows-officeworkflowdirectoryentry/#method-deconstruct-string-string-officeworkflowstreaminput) parameter `Input`
- Constructor [OfficeWorkflowProtectedSource.OfficeWorkflowProtectedSource](/api/workflows/officeimo-workflows-officeworkflowprotectedsource/#constructor-ctor-string-officeimo-workflows-officeworkflowstreaminput) parameter `inputStream`

Filter members 

Show inherited

## Constructors

OfficeWorkflowStreamInput 3 overloads

`public OfficeWorkflowStreamInput(string name, Func<CancellationToken, Task<Stream>> openRead, string? expectedSha256 = null)` [#](#constructor-ctor-string-func-system-threading-cancellationtoken-system-threading-tasks-task-system-io-stream-string)

[OfficeWorkflowStreamInput.cs:8](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L8)

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)` [#](#constructor-ctor-string-func-system-threading-cancellationtoken-system-threading-tasks-task-system-io-stream-string-officeimo-workflows-officeworkflowsourcesnapshotkind)

[OfficeWorkflowStreamInput.cs:16](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L16)

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)` [#](#member-5bc41a8be703d6ea1cc4fc51)

[OfficeWorkflowStreamInput.cs:19](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L19)

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

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public string Name { get; }` [#](#property-name)

[OfficeWorkflowStreamInput.cs:36](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L36)

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

`public OfficeWorkflowSourceSnapshotKind SnapshotKind { get; }` [#](#property-snapshotkind)

[OfficeWorkflowStreamInput.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L38)

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

`public IOfficePublicationGuard? SourcePublicationGuard { get; }` [#](#property-sourcepublicationguard)

[OfficeWorkflowStreamInput.cs:40](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L40)

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

`public Func<CancellationToken, Task<Stream>> OpenRead { get; }` [#](#property-openread)

[OfficeWorkflowStreamInput.cs:42](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L42)

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

`public string? ExpectedSha256 { get; }` [#](#property-expectedsha256)

[OfficeWorkflowStreamInput.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowStreamInput.cs#L44)

Gets the optional fingerprint captured when the input was selected.

<!-- PowerForge markdown artifact sha256:C47056FF7443C1816BC473C9B1EC9CB2A8497B2FA5F7F2B676935E6C427EB0BC -->
