struct ACP::Protocol::ConfigOption

• ACP::Protocol::ConfigOption
• Struct
• Value
• Object

Overview

A single session configuration option and its current state. Matches the Rust SDK's SessionConfigOption + SessionConfigSelect. See: https://agentclientprotocol.com/protocol/session-config-options#configoption

Included Modules

• JSON::Serializable

Defined in:

acp/protocol/types.cr

Constructors

• .new(id : String, name : String, config_type : String = "select", current_value : String | Nil = nil, options : Array(ConfigOptionValue) | Nil = nil, groups : Array(ConfigOptionGroup) | Nil = nil, description : String | Nil = nil, category : String | Nil = nil, meta : Hash(String, JSON::Any) | Nil = nil)
• .new(pull : JSON::PullParser)

Instance Method Summary

• #after_initialize : Nil

  Populate the typed #options/#groups views from the raw wire array after JSON deserialization.

• #all_values : Array(ConfigOptionValue)

  Returns all option values across all groups (flattened).

• #category : String | Nil

  Optional semantic category to help Clients provide consistent UX.

• #category=(category : String | Nil)

  Optional semantic category to help Clients provide consistent UX.

• #config_type : String

  The type of input control (required).

• #config_type=(config_type : String)

  The type of input control (required).

• #current_value : String | Nil

  The currently selected value (required).

• #current_value=(current_value : String | Nil)

  The currently selected value (required).

• #description : String | Nil

  Optional description providing more details.

• #description=(description : String | Nil)

  Optional description providing more details.

• #grouped? : Bool

  Returns true if this option uses grouped values.

• #groups : Array(ConfigOptionGroup) | Nil

  Grouped list of available values for this option (nil when flat).

• #id : String

  Unique identifier for this config option (required).

• #id=(id : String)

  Unique identifier for this config option (required).

• #label : String

  Backward-compatible alias for #name.

• #meta : Hash(String, JSON::Any) | Nil

  Extension metadata.

• #meta=(meta : Hash(String, JSON::Any) | Nil)

  Extension metadata.

• #name : String

  Human-readable label (required).

• #name=(name : String)

  Human-readable label (required).

• #options : Array(ConfigOptionValue) | Nil

  Flat list of available values for this option (nil when grouped).

• #options_raw : Array(JSON::Any) | Nil

  Raw wire form of the selectable values.

• #value : String | Nil

  Backward-compatible alias for #current_value.

Constructor Detail

Instance Method Detail