diff --git a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py index 8d9801424..ea0c74825 100644 --- a/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py +++ b/libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py @@ -8,6 +8,10 @@ class PromptOptions: + """ + Contains settings to pass to a :class:`Prompt` object when the prompt is started. + """ + def __init__( self, prompt: Activity = None, @@ -17,6 +21,23 @@ def __init__( validations: object = None, number_of_attempts: int = 0, ): + """ + Sets the initial prompt to send to the user as an :class:`botbuilder.schema.Activity`. + + :param prompt: The initial prompt to send to the user + :type prompt: :class:`botbuilder.schema.Activity` + :param retry_prompt: The retry prompt to send to the user + :type retry_prompt: :class:`botbuilder.schema.Activity` + :param choices: The choices to send to the user + :type choices: :class:`List` + :param style: The style of the list of choices to send to the user + :type style: :class:`ListStyle` + :param validations: The prompt validations + :type validations: :class:`Object` + :param number_of_attempts: The number of attempts allowed + :type number_of_attempts: :class:`int` + + """ self.prompt = prompt self.retry_prompt = retry_prompt self.choices = choices