Skip to main content

Definition

Assembly: CloudNimble.ClaudeEssentials.dll Namespace: CloudNimble.ClaudeEssentials.Hooks.Outputs Inheritance: CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase

Syntax

CloudNimble.ClaudeEssentials.Hooks.Outputs.UserPromptSubmitHookOutput

Summary

Represents the complete output for a UserPromptSubmit hook. Combines base output fields with UserPromptSubmit-specific output.

Constructors

.ctor

Syntax

public UserPromptSubmitHookOutput()

.ctor Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase

Syntax

protected HookOutputBase()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Continue Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase
Gets or sets a value indicating whether to continue with the operation. When set to false, the operation will be stopped. Defaults to true.

Syntax

public bool Continue { get; set; }

Property Value

Type: bool

Remarks

This property is always serialized to ensure explicit intent is communicated.

Decision

Gets or sets the decision for the user prompt submission. Set to HookDecision.Block to block the prompt from being processed.

Syntax

public System.Nullable<CloudNimble.ClaudeEssentials.Hooks.Enums.HookDecision> Decision { get; set; }

Property Value

Type: System.Nullable<CloudNimble.ClaudeEssentials.Hooks.Enums.HookDecision?>?

HookSpecificOutput

Gets or sets the hook-specific output containing additional context.

Syntax

public CloudNimble.ClaudeEssentials.Hooks.Outputs.UserPromptSubmitSpecificOutput HookSpecificOutput { get; set; }

Property Value

Type: CloudNimble.ClaudeEssentials.Hooks.Outputs.UserPromptSubmitSpecificOutput?

Reason

Gets or sets the reason for blocking the prompt. Only shown to the user when the prompt is blocked.

Syntax

public string Reason { get; set; }

Property Value

Type: string?

StopReason Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase
Gets or sets the reason message shown when HookOutputBase.Continue is false. This message is displayed to the user when the operation is stopped.

Syntax

public string StopReason { get; set; }

Property Value

Type: string?

SuppressOutput Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase
Gets or sets a value indicating whether to suppress output from the transcript. When true, the hook’s output will not appear in the conversation transcript. Defaults to false.

Syntax

public bool SuppressOutput { get; set; }

Property Value

Type: bool

SystemMessage Inherited

Inherited from CloudNimble.ClaudeEssentials.Hooks.Outputs.HookOutputBase
Gets or sets an optional warning message to include in the system context. This message is shown to Claude as additional context.

Syntax

public string SystemMessage { get; set; }

Property Value

Type: string?

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?