Skip to main content

Definition

Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Inputs Inheritance: CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase

Syntax

Summary

Represents the input received by an Elicitation hook. This hook runs when an elicitation dialog is presented to the user.

Remarks

The specific fields in the elicitation request depend on the MCP server that initiated the elicitation.

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

AgentId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the subagent identifier. Present only when the hook fires from within a subagent.

Syntax

Property Value

Type: string?

AgentType Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the agent type name, present within a subagent or on the main thread of a session started with --agent.

Syntax

Property Value

Type: string?

CurrentWorkingDirectory Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the current working directory where Claude Code is running.

Syntax

Property Value

Type: string

Effort Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the reasoning effort applied to the current turn.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.Inputs.HookEffortInfo?

ElicitationId

Gets or sets the elicitation identifier.

Syntax

Property Value

Type: string?

HookEventName Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the name of the hook event that triggered this input.

Syntax

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.HookEventName?

McpServerName

Gets or sets the name of the MCP server requesting input.

Syntax

Property Value

Type: string

Message

Gets or sets the message to show the user.

Syntax

Property Value

Type: string

Mode

Gets or sets how input is collected.

Syntax

Property Value

Type: System.Nullable<CloudNimble.ClaudeEssentials.Hooks.ElicitationMode>

PermissionMode Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the permission mode under which Claude Code is operating.

Syntax

Property Value

Type: System.Nullable<CloudNimble.ClaudeEssentials.Hooks.PermissionMode?>?

PromptId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the UUID correlating a user prompt with all subsequent events until the next prompt.

Syntax

Property Value

Type: string?

RequestedSchema

Gets or sets the JSON schema of the requested input.

Syntax

Property Value

Type: System.Collections.Generic.Dictionary<string, System.Text.Json.JsonElement>

SessionId Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the unique identifier for the current Claude Code session.

Syntax

Property Value

Type: string

TranscriptPath Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase
Gets or sets the file path to the transcript JSONL file for the current session. This file contains the full conversation history.

Syntax

Property Value

Type: string

Url

Gets or sets the URL to send the user to in URL mode.

Syntax

Property Value

Type: string?

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?