Skip to content

mm-api-ref-docs-prompt-options #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2020
Merged

mm-api-ref-docs-prompt-options #601

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e24ae2
Update prompt_options.py
Jan 14, 2020
8fa2dee
Update prompt_options.py
Jan 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Expand Down