Remove usage of CreateReply method from all samples. (#1575)

Author: Eric Dahlvang

samples/csharp_dotnetcore/03.welcome-user/Bots/WelcomeUserBot.cs

@@ -106,8 +106,6 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
 
         private static async Task SendIntroCardAsync(ITurnContext turnContext, CancellationToken cancellationToken)
         {
-            var response = turnContext.Activity.CreateReply();
-
             var card = new HeroCard();
             card.Title = "Welcome to Bot Framework!";
             card.Text = @"Welcome to Welcome Users bot sample! This Introduction card
@@ -121,8 +119,8 @@ some things to get them started. We use this opportunity to
                 new CardAction(ActionTypes.OpenUrl, "Ask a question", null, "Ask a question", "Ask a question", "https://stackoverflow.com/questions/tagged/botframework"),
                 new CardAction(ActionTypes.OpenUrl, "Learn how to deploy", null, "Learn how to deploy", "Learn how to deploy", "https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-deploy-azure?view=azure-bot-service-4.0"),
             };
-
-            response.Attachments = new List<Attachment>() { card.ToAttachment() };
+            
+            var response = MessageFactory.Attachment(card.ToAttachment());
             await turnContext.SendActivityAsync(response, cancellationToken);
         }
     }

samples/csharp_dotnetcore/06.using-cards/Dialogs/MainDialog.cs

@@ -57,14 +57,14 @@ private async Task<DialogTurnResult> ChoiceCardStepAsync(WaterfallStepContext st
         private async Task<DialogTurnResult> ShowCardStepAsync(WaterfallStepContext stepContext, CancellationToken cancellationToken)
         {
             _logger.LogInformation("MainDialog.ShowCardStepAsync");
-
-            // Reply to the activity we received with an activity.
-            var reply = stepContext.Context.Activity.CreateReply();
-
+            
             // Cards are sent as Attachments in the Bot Framework.
-            // So we need to create a list of attachments on the activity.
-            reply.Attachments = new List<Attachment>();
-
+            // So we need to create a list of attachments for the reply activity.
+            var attachments = new List<Attachment>();
+            
+            // Reply to the activity we received with an activity.
+            var reply = MessageFactory.Attachment(attachments);
+            
             // Decide which type of card(s) we are going to show the user
             switch (((FoundChoice)stepContext.Result).Value)
             {

samples/csharp_dotnetcore/08.suggested-actions/Bots/SuggestedActionsBot.cs

@@ -86,7 +86,8 @@ private static string ProcessInput(string text)
         /// "ActionTypes" that may be used for different situations.
         private static async Task SendSuggestedActionsAsync(ITurnContext turnContext, CancellationToken cancellationToken)
         {
-            var reply = turnContext.Activity.CreateReply("What is your favorite color?");
+            var reply = MessageFactory.Text("What is your favorite color?");
+
             reply.SuggestedActions = new SuggestedActions()
             {
                 Actions = new List<CardAction>()

samples/csharp_dotnetcore/15.handling-attachments/Bots/AttachmentsBot.cs

@@ -38,8 +38,6 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
 
         private static async Task DisplayOptionsAsync(ITurnContext turnContext, CancellationToken cancellationToken)
         {
-            var reply = turnContext.Activity.CreateReply();
-
             // Create a HeroCard with options for the user to interact with the bot.
             var card = new HeroCard
             {
@@ -55,9 +53,7 @@ private static async Task DisplayOptionsAsync(ITurnContext turnContext, Cancella
                 },
             };
 
-            // Add the card to our reply.
-            reply.Attachments = new List<Attachment>() { card.ToAttachment() };
-
+            var reply = MessageFactory.Attachment(card.ToAttachment());
             await turnContext.SendActivityAsync(reply, cancellationToken);
         }
 
@@ -79,53 +75,56 @@ await turnContext.SendActivityAsync(
         }
 
         // Given the input from the message, create the response.
-        private static Activity ProcessInput(ITurnContext turnContext)
+        private static IMessageActivity ProcessInput(ITurnContext turnContext)
         {
             var activity = turnContext.Activity;
-            var reply = activity.CreateReply();
+            IMessageActivity reply = null;
 
             if (activity.Attachments != null && activity.Attachments.Any())
             {
                 // We know the user is sending an attachment as there is at least one item
                 // in the Attachments list.
-                HandleIncomingAttachment(activity, reply);
+                reply = HandleIncomingAttachment(activity);
             }
             else
             {
                 // Send at attachment to the user.
-                HandleOutgoingAttachment(activity, reply);
+                reply = HandleOutgoingAttachment(turnContext, activity);
             }
 
             return reply;
         }
 
-        // Adds an attachment to the 'reply' parameter that is passed in.
-        private static void HandleOutgoingAttachment(IMessageActivity activity, IMessageActivity reply)
+        // Returns a reply with the requested Attachment
+        private static IMessageActivity HandleOutgoingAttachment(ITurnContext turnContext, IMessageActivity activity)
         {
             // Look at the user input, and figure out what kind of attachment to send.
+            IMessageActivity reply = null;
             if (activity.Text.StartsWith("1"))
             {
-                reply.Text = "This is an inline attachment.";
+                reply = MessageFactory.Text("This is an inline attachment.");
                 reply.Attachments = new List<Attachment>() { GetInlineAttachment() };
             }
             else if (activity.Text.StartsWith("2"))
             {
-                reply.Text = "This is an attachment from a HTTP URL.";
+                reply = MessageFactory.Text("This is an attachment from a HTTP URL.");
                 reply.Attachments = new List<Attachment>() { GetInternetAttachment() };
             }
             else if (activity.Text.StartsWith("3"))
             {
-                reply.Text = "This is an uploaded attachment.";
+                reply = MessageFactory.Text("This is an uploaded attachment.");
 
                 // Get the uploaded attachment.
-                var uploadedAttachment = GetUploadedAttachmentAsync(reply.ServiceUrl, reply.Conversation.Id).Result;
+                var uploadedAttachment = GetUploadedAttachmentAsync(turnContext, activity.ServiceUrl, activity.Conversation.Id).Result;
                 reply.Attachments = new List<Attachment>() { uploadedAttachment };
             }
             else
             {
                 // The user did not enter input that this bot was built to handle.
-                reply.Text = "Your input was not recognized please try again.";
+                reply = MessageFactory.Text("Your input was not recognized please try again.");
             }
+
+            return reply;
         }
 
 
@@ -135,8 +134,9 @@ private static void HandleOutgoingAttachment(IMessageActivity activity, IMessage
         // on file type, size, and other attributes. Consult the documentation for the channel for
         // more information. For example Skype's limits are here
         // <see ref="https://support.skype.com/en/faq/FA34644/skype-file-sharing-file-types-size-and-time-limits"/>.
-        private static void HandleIncomingAttachment(IMessageActivity activity, IMessageActivity reply)
+        private static IMessageActivity HandleIncomingAttachment(IMessageActivity activity)
         {
+            string replyText = string.Empty;
             foreach (var file in activity.Attachments)
             {
                 // Determine where the file is hosted.
@@ -151,9 +151,11 @@ private static void HandleIncomingAttachment(IMessageActivity activity, IMessage
                     webClient.DownloadFile(remoteFileUrl, localFileName);
                 }
 
-                reply.Text = $"Attachment \"{activity.Attachments[0].Name}\"" +
-                             $" has been received and saved to \"{localFileName}\"";
+                replyText += $"Attachment \"{file.Name}\"" +
+                             $" has been received and saved to \"{localFileName}\"\r\n";
             }
+
+            return MessageFactory.Text(replyText);
         }
 
 
@@ -176,7 +178,7 @@ private static Attachment GetInlineAttachment()
         }
 
         // Creates an "Attachment" to be sent from the bot to the user from an uploaded file.
-        private static async Task<Attachment> GetUploadedAttachmentAsync(string serviceUrl, string conversationId)
+        private static async Task<Attachment> GetUploadedAttachmentAsync(ITurnContext turnContext, string serviceUrl, string conversationId)
         {
             if (string.IsNullOrWhiteSpace(serviceUrl))
             {
@@ -190,28 +192,25 @@ private static async Task<Attachment> GetUploadedAttachmentAsync(string serviceU
 
             var imagePath = Path.Combine(Environment.CurrentDirectory, @"Resources\architecture-resize.png");
 
-            // Create a connector client to use to upload the image.
-            using (var connector = new ConnectorClient(new Uri(serviceUrl)))
-            {
-                var attachments = new Attachments(connector);
-                var response = await attachments.Client.Conversations.UploadAttachmentAsync(
-                    conversationId,
-                    new AttachmentData
-                    {
-                        Name = @"Resources\architecture-resize.png",
-                        OriginalBase64 = File.ReadAllBytes(imagePath),
-                        Type = "image/png",
-                    });
-
-                var attachmentUri = attachments.GetAttachmentUri(response.Id);
-
-                return new Attachment
+            var connector = turnContext.TurnState.Get<IConnectorClient>() as ConnectorClient;
+            var attachments = new Attachments(connector);
+            var response = await attachments.Client.Conversations.UploadAttachmentAsync(
+                conversationId,
+                new AttachmentData
                 {
                     Name = @"Resources\architecture-resize.png",
-                    ContentType = "image/png",
-                    ContentUrl = attachmentUri,
-                };
-            }
+                    OriginalBase64 = File.ReadAllBytes(imagePath),
+                    Type = "image/png",
+                });
+
+            var attachmentUri = attachments.GetAttachmentUri(response.Id);
+
+            return new Attachment
+            {
+                Name = @"Resources\architecture-resize.png",
+                ContentType = "image/png",
+                ContentUrl = attachmentUri,
+            };
         }
 
         // Creates an <see cref="Attachment"/> to be sent from the bot to the user from a HTTP URL.

samples/csharp_dotnetcore/16.proactive-messages/Bots/ProactiveBot.cs

@@ -43,7 +43,7 @@ protected override async Task OnMembersAddedAsync(IList<ChannelAccount> membersA
                 // Greet anyone that was not the target (recipient) of this message.
                 if (member.Id != turnContext.Activity.Recipient.Id)
                 {
-                    await turnContext.SendActivityAsync(((Activity)turnContext.Activity).CreateReply(WelcomeMessage), cancellationToken);
+                    await turnContext.SendActivityAsync(MessageFactory.Text(WelcomeMessage), cancellationToken);
                 }
             }
         }
@@ -53,7 +53,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
             AddConversationReference(turnContext.Activity as Activity);
 
             // Echo back what the user said
-            await turnContext.SendActivityAsync(((Activity)turnContext.Activity).CreateReply($"You sent '{turnContext.Activity.Text}'"), cancellationToken);
+            await turnContext.SendActivityAsync(MessageFactory.Text($"You sent '{turnContext.Activity.Text}'"), cancellationToken);
         }
     }
 }

samples/csharp_dotnetcore/17.multilingual-bot/Bots/MultiLingualBot.cs

@@ -55,8 +55,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
                 // selected language.
                 // If Spanish was selected by the user, the reply below will actually be shown in spanish to the user.
                 await _languagePreference.SetAsync(turnContext, lang, cancellationToken);
-                var reply = ((Activity)turnContext.Activity).CreateReply($"Your current language code is: {lang}");
-
+                var reply = MessageFactory.Text($"Your current language code is: {lang}");
                 await turnContext.SendActivityAsync(reply, cancellationToken);
 
                 // Save the user profile updates into the user state.
@@ -67,7 +66,7 @@ protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivi
                 // Show the user the possible options for language. If the user chooses a different language
                 // than the default, then the translation middleware will pick it up from the user state and
                 // translate messages both ways, i.e. user to bot and bot to user.
-                var reply = ((Activity)turnContext.Activity).CreateReply("Choose your language:");
+                var reply = MessageFactory.Text("Choose your language:");
                 reply.SuggestedActions = new SuggestedActions()
                 {
                     Actions = new List<CardAction>()
@@ -90,21 +89,13 @@ private static async Task SendWelcomeMessageAsync(ITurnContext turnContext, Canc
                 if (member.Id != turnContext.Activity.Recipient.Id)
                 {
                     var welcomeCard = CreateAdaptiveCardAttachment();
-                    var response = CreateResponse(turnContext.Activity, welcomeCard);
+                    var response = MessageFactory.Attachment(welcomeCard);
                     await turnContext.SendActivityAsync(response, cancellationToken);
-                    await turnContext.SendActivityAsync(turnContext.Activity.CreateReply(WelcomeText), cancellationToken);
+                    await turnContext.SendActivityAsync(MessageFactory.Text(WelcomeText), cancellationToken);
                 }
             }
         }
 
-        // Create an attachment message response.
-        private static Activity CreateResponse(IActivity activity, Attachment attachment)
-        {
-            var response = ((Activity)activity).CreateReply();
-            response.Attachments = new List<Attachment>() { attachment };
-            return response;
-        }
-
         // Load attachment from file.
         private static Attachment CreateAdaptiveCardAttachment()
         {

samples/csharp_dotnetcore/23.facebook-events/Bots/FacebookBot.cs

@@ -135,7 +135,7 @@ protected virtual async Task OnFacebookPostBack(ITurnContext turnContext, Facebo
             // TODO: Your PostBack handling logic here...
 
             // Answer the postback, and show choices
-            var reply = turnContext.Activity.CreateReply($"Are you sure?");
+            var reply = MessageFactory.Text("Are you sure?");
             await turnContext.SendActivityAsync(reply, cancellationToken);
             await ShowChoices(turnContext, cancellationToken);
         }
@@ -156,7 +156,7 @@ protected virtual async Task OnFacebookQuickReply(ITurnContext turnContext, Face
                 // The Facebook page id from which the message comes from is in turnContext.Activity.Recipient.Id.
                 case FacebookPageIdOption:
                     {
-                        var reply = turnContext.Activity.CreateReply($"This message comes from the following Facebook Page: {turnContext.Activity.Recipient.Id}");
+                        var reply = MessageFactory.Text($"This message comes from the following Facebook Page: {turnContext.Activity.Recipient.Id}");
                         await turnContext.SendActivityAsync(reply, cancellationToken);
                         await ShowChoices(turnContext, cancellationToken);
 
@@ -175,9 +175,8 @@ protected virtual async Task OnFacebookQuickReply(ITurnContext turnContext, Face
                                         new CardAction() { Title = "No", Type = ActionTypes.PostBack, Value = "No" },
                                     },
                         };
-
-                        var reply = turnContext.Activity.CreateReply();
-                        reply.Attachments = new List<Attachment> { card.ToAttachment() };
+                        
+                        var reply = MessageFactory.Attachment(card.ToAttachment());
                         await turnContext.SendActivityAsync(reply, cancellationToken);
 
                         break;

samples/csharp_dotnetcore/24.bot-authentication-msgraph/OAuthHelpers.cs

@@ -78,7 +78,7 @@ public static async Task ListRecentMailAsync(ITurnContext turnContext, TokenResp
 
             var client = new SimpleGraphClient(tokenResponse.Token);
             var messages = await client.GetRecentMailAsync();
-            var reply = turnContext.Activity.CreateReply();
+            IMessageActivity reply = null;
 
             if (messages.Any())
             {
@@ -88,7 +88,7 @@ public static async Task ListRecentMailAsync(ITurnContext turnContext, TokenResp
                     count = 5;
                 }
 
-                reply.Attachments = new List<Attachment>();
+                reply = MessageFactory.Attachment(new List<Attachment>());
                 reply.AttachmentLayout = AttachmentLayoutTypes.Carousel;
 
                 for (var i = 0; i < count; i++)
@@ -109,7 +109,7 @@ public static async Task ListRecentMailAsync(ITurnContext turnContext, TokenResp
             }
             else
             {
-                reply.Text = "Unable to find any recent unread mail.";
+                reply = MessageFactory.Text("Unable to find any recent unread mail.");
             }
 
             await turnContext.SendActivityAsync(reply);