IDialogContext.cs
1 //
2 // Copyright (c) Microsoft. All rights reserved.
3 // Licensed under the MIT license.
4 //
5 // Microsoft Bot Framework: http://botframework.com
6 //
7 // Bot Builder SDK GitHub:
8 // https://github.com/Microsoft/BotBuilder
9 //
10 // Copyright (c) Microsoft Corporation
11 // All rights reserved.
12 //
13 // MIT License:
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
21 //
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
24 //
25 // THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 //
33 
34 using System.Threading;
35 using System.Threading.Tasks;
36 
38 using Microsoft.Bot.Connector;
39 
40 namespace Microsoft.Bot.Builder.Dialogs
41 {
52  public delegate Task ResumeAfter<in T>(IDialogContext context, IAwaitable<T> result);
53 
59  public delegate Task StartAsync(IDialogContext context);
60 
64  public interface IBotContext : IBotData, IBotToUser
65  {
66  CancellationToken CancellationToken { get; }
67 
76  }
77 
82  {
83  }
84 
88  public static partial class Extensions
89  {
101  public static async Task PostAsync(this IBotToUser botToUser, string text, string locale = null, CancellationToken cancellationToken = default(CancellationToken))
102  {
103  var message = botToUser.MakeMessage();
104  message.Text = text;
105 
106  if (!string.IsNullOrEmpty(locale))
107  {
108  message.Locale = locale;
109  }
110 
111  await botToUser.PostAsync(message, cancellationToken);
112  }
113 
119  public static void Wait(this IDialogStack stack, ResumeAfter<IMessageActivity> resume)
120  {
121  stack.Wait<IMessageActivity>(resume);
122  }
123 
134  public static async Task Forward<R>(this IDialogStack stack, IDialog<R> child, ResumeAfter<R> resume, IMessageActivity message, CancellationToken token)
135  {
136  await stack.Forward<R, IMessageActivity>(child, resume, message, token);
137  }
138  }
139 }
The context for the execution of a dialog&#39;s conversational process.
Namespace for the Microsoft Bot Connector SDK.
string Text
Content for the message
Task PostAsync(IMessageActivity message, CancellationToken cancellationToken=default(CancellationToken))
Post a message to be sent to the user.
static async Task PostAsync(this IBotToUser botToUser, string text, string locale=null, CancellationToken cancellationToken=default(CancellationToken))
Post a message to be sent to the bot, using previous messages to establish a conversation context...
An Activity is the basic communication type for the Bot Framework 3.0 protocol
Definition: ActivityEx.cs:18
delegate Task StartAsync(IDialogContext context)
Encapsulate a method that represents the code to start a dialog.
Namespace for internal Dialogs machinery that is not useful for most developers and may change in the...
static void Wait(this IDialogStack stack, ResumeAfter< IMessageActivity > resume)
Suspend the current dialog until the user has sent a message to the bot.
Shared properties for all activities
Definition: IActivity.cs:9
IMessageActivity MakeMessage()
Make a message.
Core namespace for Dialogs and associated infrastructure.
Methods to send a message from the bot to the user.
Definition: BotToUser.cs:51
The stack of dialogs in the conversational process.
Definition: IDialogTask.cs:46
Root namespace for the Microsoft Bot Builder SDK.