# OfficeWorkflowDiagnostic

One immutable structured workflow diagnostic.

Class 

`OfficeIMO.Workflows`

**Namespace**

`OfficeIMO.Workflows`

**Assembly**

`OfficeIMO.Workflows`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[OfficeWorkflowContracts.cs:81](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L81)

**Modifiers**

sealed

One immutable structured workflow diagnostic.

## Inheritance

- object
- OfficeWorkflowDiagnostic

## Usage

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

- Property [ImageOcrWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-imageocrworkflowresult/#property-diagnostics)
- Property [OfficeInvoiceStorageWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-officeinvoicestorageworkflowresult/#property-diagnostics)
- Property [OfficeOcrSessionResult.Diagnostics](/api/workflows/officeimo-workflows-officeocrsessionresult/#property-diagnostics)
- Property [OfficeProvenanceWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-officeprovenanceworkflowresult/#property-diagnostics)
- Property [OfficeWorkflowDocumentPreview.Diagnostics](/api/workflows/officeimo-workflows-officeworkflowdocumentpreview/#property-diagnostics)
- Property [OfficeWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-officeworkflowresult/#property-diagnostics)
- Property [PdfAssemblyResult.Diagnostics](/api/workflows/officeimo-workflows-pdfassemblyresult/#property-diagnostics)
- Property [PdfPageImageExportResult.Diagnostics](/api/workflows/officeimo-workflows-pdfpageimageexportresult/#property-diagnostics)
- Property [PdfRedactionWorkflowRecord.Diagnostics](/api/workflows/officeimo-workflows-pdfredactionworkflowrecord/#property-diagnostics)
- Property [PdfRedactionWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-pdfredactionworkflowresult/#property-diagnostics)
- Property [PdfSearchableWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-pdfsearchableworkflowresult/#property-diagnostics)
- Property [PdfSplitWorkflowResult.Diagnostics](/api/workflows/officeimo-workflows-pdfsplitworkflowresult/#property-diagnostics)

Filter members 

Show inherited

## Constructors

`public OfficeWorkflowDiagnostic(string code, string message, OfficeWorkflowDiagnosticSeverity severity = Information, string? stage = null, IReadOnlyDictionary<string, string>? details = null)` [#](#constructor-ctor-string-string-officeimo-workflows-officeworkflowdiagnosticseverity-string-collections-generic-ireadonlydictionary-system-string-system-string)

[OfficeWorkflowContracts.cs:81](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L81)

Creates a workflow diagnostic.

Parameters

**code string required**

**message string required**

**severity OfficeIMO.Workflows.OfficeWorkflowDiagnosticSeverity = Information optional**

**stage string? = null optional**

**details System.Collections.Generic.IReadOnlyDictionary<string, string>? = null optional**

## 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 Code { get; }` [#](#property-code)

[OfficeWorkflowContracts.cs:98](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L98)

Stable machine-readable code.

`public string Message { get; }` [#](#property-message)

[OfficeWorkflowContracts.cs:100](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L100)

Human-readable explanation.

`public OfficeWorkflowDiagnosticSeverity Severity { get; }` [#](#property-severity)

[OfficeWorkflowContracts.cs:102](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L102)

Diagnostic severity.

`public string? Stage { get; }` [#](#property-stage)

[OfficeWorkflowContracts.cs:104](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L104)

Workflow stage that produced the diagnostic.

`public IReadOnlyDictionary<string, string> Details { get; }` [#](#property-details)

[OfficeWorkflowContracts.cs:106](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Workflows/OfficeWorkflowContracts.cs#L106)

Additional machine-readable evidence.

<!-- PowerForge markdown artifact sha256:077CBC45F4E3EEE3857A30E7339840A48F14291F00CC09124A60106FCF212175 -->
