/
DialogReason.yml
72 lines (58 loc) · 2.32 KB
/
DialogReason.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
### YamlMime:TSEnum
name: DialogReason
uid: botbuilder-dialogs.DialogReason
package: botbuilder-dialogs
summary: Indicates why a dialog method is being called.
fullName: DialogReason
remarks: >-
Use a dialog context to control the dialogs in a dialog set. The dialog
context will pass a reference to itself
to the dialog method it calls. It also passes in the _reason_ why the specific
method is being called.
**See also**
- [DialogContext](xref:botbuilder-dialogs.DialogContext)
- [DialogSet](xref:botbuilder-dialogs.DialogSet)
- [Dialog](xref:botbuilder-dialogs.Dialog)
isPreview: false
isDeprecated: false
fields:
- name: beginCalled
uid: botbuilder-dialogs.DialogReason.beginCalled
package: botbuilder-dialogs
summary: >-
The dialog is being started from
[DialogContext.beginDialog](xref:botbuilder-dialogs.DialogContext.beginDialog)
or
[DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog).
- name: cancelCalled
uid: botbuilder-dialogs.DialogReason.cancelCalled
package: botbuilder-dialogs
summary: >-
The dialog is being cancelled from
[DialogContext.cancelAllDialogs](xref:botbuilder-dialogs.DialogContext.cancelAllDialogs).
- name: continueCalled
uid: botbuilder-dialogs.DialogReason.continueCalled
package: botbuilder-dialogs
summary: >-
The dialog is being continued from
[DialogContext.continueDialog](xref:botbuilder-dialogs.DialogContext.continueDialog).
- name: endCalled
uid: botbuilder-dialogs.DialogReason.endCalled
package: botbuilder-dialogs
summary: >-
The dialog is being ended from
[DialogContext.endDialog](xref:botbuilder-dialogs.DialogContext.endDialog).
- name: nextCalled
uid: botbuilder-dialogs.DialogReason.nextCalled
package: botbuilder-dialogs
summary: >-
A step in a [WaterfallDialog](xref:botbuilder-dialogs.WaterfallDialog) is
being called
because the previous step in the waterfall dialog called
[WaterfallStepContext.next](xref:botbuilder-dialogs.WaterfallStepContext.next).
- name: replaceCalled
uid: botbuilder-dialogs.DialogReason.replaceCalled
package: botbuilder-dialogs
summary: >-
The dialog is being ended from
[DialogContext.replaceDialog](xref:botbuilder-dialogs.DialogContext.replaceDialog).