askQuestion

codebolt.chat.askQuestion(question: string, buttons: string[], withFeedback: boolean): Promise<askQuestion>

Asks a question to the user.

Parameters

Name	Type	Description
question	string	The question text to present to the user.
buttons	string[]	An array of button labels. Defaults to an empty array if not specified.
withFeedback	boolean	Whether to allow additional feedback input. Default is false.

Returns:

 Promise<askQuestion>

A promise that resolves with the user's response.

Response Structure

The method returns a Promise that resolves to a string containing the user's response or button selection.

This method waits for the user to respond to the question and returns their selection as a string. The response corresponds to:

• The text of the button the user clicked (if buttons are provided)
• The feedback text if withFeedback is enabled and the user provides additional input
• Free-form text input if no buttons are specified
• The exact button label if custom buttons are provided

Note: While the underlying WebSocket response contains additional metadata (messageId, threadId, timestamp, etc.), this method extracts and returns only the user's actual response/selection for simplicity.

Examples

// Example 1: Simple question with default options (no buttons)
const response1 = await codebolt.chat.askQuestion("What would you like to do next?");
console.log('User response:', response1);

// Example 2: Question with custom button options
const response2 = await codebolt.chat.askQuestion(
    "How would you like to proceed?",
    ["Continue", "Skip", "Cancel"]
);
console.log('Selected option:', response2);

// Example 3: Question with buttons and feedback input enabled
const response3 = await codebolt.chat.askQuestion(
    "Are you satisfied with the current results?",
    ["Yes", "No", "Need Improvements"],
    true
);
console.log('User feedback:', response3);

// Example 4: Configuration choice question
const configChoice = await codebolt.chat.askQuestion(
    "Which configuration would you like to use?",
    ["Development", "Staging", "Production"],
    false
);
console.log('Selected configuration:', configChoice);

// Example 5: Error handling with question
const errorAction = await codebolt.chat.askQuestion(
    "An error occurred during processing. What would you like to do?",
    ["Retry", "Skip this step", "Abort process"],
    true
);
console.log('Error action choice:', errorAction);

// Example 6: Accessing the feedback message from response
const userChoice = await codebolt.chat.askQuestion(
    "Do you want to continue?",
    ["Yes", "No"]
);
// Access the actual user selection
const selectedOption = userChoice.message.feedbackMessage;
console.log('User selected:', selectedOption);

Explanation

• Interactive Communication: This function creates an interactive dialog with the user, pausing script execution until a response is received
• Button Customization: You can provide custom button labels to give users specific options to choose from
• Feedback Option: When withFeedback is true, users can provide additional text input along with their button selection
• Asynchronous Operation: The function returns a Promise that resolves with the user's response as a string
• Default Behavior: If no buttons are provided, the user can input free-form text as their response