> ## Documentation Index
> Fetch the complete documentation index at: https://si.easyaf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# WorkflowToolResponse

> Represents the response payload returned by the Workflow tool.

## Definition

**Assembly:** CloudNimble.ClaudeEssentials.dll

**Namespace:** CloudNimble.ClaudeEssentials.Hooks.Tools.Responses

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.WorkflowToolResponse
```

## Summary

Represents the response payload returned by the Workflow tool.

## Constructors

###  .ctor

#### Syntax

```csharp theme={"dark"}
public WorkflowToolResponse()
```

###  .ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

###  Error

Gets or sets the error message, set if the syntax check failed.

#### Syntax

```csharp theme={"dark"}
public string Error { get; set; }
```

#### Property Value

Type: `string?`

###  RunId

Gets or sets the local workflow run identifier to pass as `resumeFromRunId`.

#### Syntax

```csharp theme={"dark"}
public string RunId { get; set; }
```

#### Property Value

Type: `string?`

###  ScriptPath

Gets or sets the path to the persisted workflow script for this invocation.

#### Syntax

```csharp theme={"dark"}
public string ScriptPath { get; set; }
```

#### Property Value

Type: `string?`

###  SessionUrl

Gets or sets the cloud session URL when the status is remote\_launched.

#### Syntax

```csharp theme={"dark"}
public string SessionUrl { get; set; }
```

#### Property Value

Type: `string?`

###  Status

Gets or sets how the workflow was launched.

#### Syntax

```csharp theme={"dark"}
public CloudNimble.ClaudeEssentials.Hooks.WorkflowLaunchStatus Status { get; set; }
```

#### Property Value

Type: `CloudNimble.ClaudeEssentials.Hooks.WorkflowLaunchStatus?`

###  Summary

Gets or sets the launch summary.

#### Syntax

```csharp theme={"dark"}
public string Summary { get; set; }
```

#### Property Value

Type: `string?`

###  TaskId

Gets or sets the ID of the background task.

#### Syntax

```csharp theme={"dark"}
public string TaskId { get; set; }
```

#### Property Value

Type: `string`

###  TaskType

Gets or sets the type of the registered background task.

#### Syntax

```csharp theme={"dark"}
public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.WorkflowTaskType> TaskType { get; set; }
```

#### Property Value

Type: `System.Nullable<CloudNimble.ClaudeEssentials.Hooks.WorkflowTaskType?>?`

### &#x20;TranscriptDir

Gets or sets the directory where subagent transcripts are written during execution.

#### Syntax

```csharp theme={"dark"}
public string TranscriptDir { get; set; }
```

#### Property Value

Type: `string?`

### &#x20;Warning

Gets or sets a non-blocking heads-up, such as local git state diverging from the pushed branch.

#### Syntax

```csharp theme={"dark"}
public string Warning { get; set; }
```

#### Property Value

Type: `string?`

### &#x20;WorkflowName

Gets or sets the `meta.name` value from the workflow script.

#### Syntax

```csharp theme={"dark"}
public string WorkflowName { get; set; }
```

#### Property Value

Type: `string?`

## Methods

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.