Struct SessionUi 

pub struct SessionUi<'a> { /* private fields */ }

UI sub-API for a Session — elicitation, confirmation, selection, and free-form input.

Acquired via Session::ui. Methods route to session.ui.* RPCs and require host elicitation support — check session.capabilities().ui.elicitation before use.

Implementations

impl<'a> SessionUi<'a>

pub async fn elicitation( &self, message: &str, schema: Value, ) -> Result<ElicitationResult, Error>

Request user input via an interactive UI form (elicitation).

Sends a JSON Schema describing form fields to the CLI host. The host renders a form dialog and returns the user’s response.

Prefer the typed convenience methods confirm, select, and input for common cases.

pub async fn confirm(&self, message: &str) -> Result<bool, Error>

Ask the user a yes/no confirmation question.

Returns true if the user accepted and confirmed, false otherwise.

pub async fn select( &self, message: &str, options: &[&str], ) -> Result<Option<String>, Error>

Ask the user to select from a list of options.

Returns the selected option string on accept, or None on decline/cancel.

pub async fn input( &self, message: &str, options: Option<&InputOptions<'_>>, ) -> Result<Option<String>, Error>

Ask the user for free-form text input.

Returns the input string on accept, or None on decline/cancel. Use InputOptions to set validation constraints and field metadata.