Skip to content

Commit 516f723

Browse files
authored
Merge pull request #601 from microsoft/mm-api-ref-docs-prompt-options
mm-api-ref-docs-prompt-options
2 parents 9471670 + 8fa2dee commit 516f723

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

libraries/botbuilder-dialogs/botbuilder/dialogs/prompts/prompt_options.py

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99

1010
class PromptOptions:
11+
"""
12+
Contains settings to pass to a :class:`Prompt` object when the prompt is started.
13+
"""
14+
1115
def __init__(
1216
self,
1317
prompt: Activity = None,
@@ -17,6 +21,23 @@ def __init__(
1721
validations: object = None,
1822
number_of_attempts: int = 0,
1923
):
24+
"""
25+
Sets the initial prompt to send to the user as an :class:`botbuilder.schema.Activity`.
26+
27+
:param prompt: The initial prompt to send to the user
28+
:type prompt: :class:`botbuilder.schema.Activity`
29+
:param retry_prompt: The retry prompt to send to the user
30+
:type retry_prompt: :class:`botbuilder.schema.Activity`
31+
:param choices: The choices to send to the user
32+
:type choices: :class:`List`
33+
:param style: The style of the list of choices to send to the user
34+
:type style: :class:`ListStyle`
35+
:param validations: The prompt validations
36+
:type validations: :class:`Object`
37+
:param number_of_attempts: The number of attempts allowed
38+
:type number_of_attempts: :class:`int`
39+
40+
"""
2041
self.prompt = prompt
2142
self.retry_prompt = retry_prompt
2243
self.choices = choices

0 commit comments

Comments
 (0)