IActivityLogger.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 
36 using Microsoft.Bot.Connector;
37 using Newtonsoft.Json;
38 using System.Diagnostics;
39 using System.Threading;
40 using System.Threading.Tasks;
41 
42 namespace Microsoft.Bot.Builder.History
43 {
47  public interface IActivityLogger
48  {
49  Task LogAsync(IActivity activity);
50  }
51 
65  public sealed class TraceActivityLogger : IActivityLogger
66  {
72  async Task IActivityLogger.LogAsync(IActivity activity)
73  {
74  Trace.TraceInformation(JsonConvert.SerializeObject(activity));
75  }
76  }
77 
81  public sealed class NullActivityLogger : IActivityLogger
82  {
88  async Task IActivityLogger.LogAsync(IActivity activity)
89  {
90  }
91  }
92 }
93 
94 namespace Microsoft.Bot.Builder.Dialogs.Internals
95 {
96  public sealed class LogPostToBot : IPostToBot
97  {
98  private readonly IPostToBot inner;
99  private readonly IActivityLogger logger;
101  {
102  SetField.NotNull(out this.inner, nameof(inner), inner);
103  SetField.NotNull(out this.logger, nameof(logger), logger);
104  }
105 
106  async Task IPostToBot.PostAsync(IActivity activity, CancellationToken token)
107  {
108  await this.logger.LogAsync(activity);
109  await inner.PostAsync(activity, token);
110  }
111  }
112 
113  public sealed class LogBotToUser : IBotToUser
114  {
115  private readonly IBotToUser inner;
116  private readonly IActivityLogger logger;
118  {
119  SetField.NotNull(out this.inner, nameof(inner), inner);
120  SetField.NotNull(out this.logger, nameof(logger), logger);
121  }
122 
124  {
125  return this.inner.MakeMessage();
126  }
127 
128  async Task IBotToUser.PostAsync(IMessageActivity message, CancellationToken cancellationToken)
129  {
130  await this.logger.LogAsync(message);
131  await this.inner.PostAsync(message, cancellationToken);
132  }
133  }
134 }
LogPostToBot(IPostToBot inner, IActivityLogger logger)
Activity logger that traces to the console.
Namespace for the Microsoft Bot Connector SDK.
Namespace for interfaces and classes for working with conversational history.
Log message activities between bots and users.
Namespace for internal machinery that is not useful for most developers and may change in the future...
Methods to send a message from the user to the bot.
Definition: PostToBot.cs:50
Task PostAsync(IActivity activity, CancellationToken token)
Post an item (e.g. message or other external event) to the bot.
Task PostAsync(IMessageActivity message, CancellationToken cancellationToken=default(CancellationToken))
Post a message to be sent to the user.
Shared properties for all activities
Definition: IActivity.cs:9
LogBotToUser(IBotToUser inner, IActivityLogger logger)
Activity logger that doesn't log.
IMessageActivity MakeMessage()
Make a message.
Namespace for the internal fibers machinery that is not useful for most developers and may change in ...
Methods to send a message from the bot to the user.
Definition: BotToUser.cs:51
Root namespace for the Microsoft Bot Builder SDK.