Merge pull request #220 from Deep-Blue-2013/master

RichMessageBase and Welcome message.

Author: Oceania2018

src/Infrastructure/BotSharp.Abstraction/Conversations/ConversationHookBase.cs

@@ -81,4 +81,9 @@ public virtual Task OnConversationInitialized(Conversation conversation)
     {
         return Task.CompletedTask;
     }
+
+    public virtual Task OnUserAgentConnectedInitially(Conversation conversation)
+    {
+        return Task.CompletedTask;
+    }
 }

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationHook.cs

@@ -10,6 +10,14 @@ public interface IConversationHook
     Conversation Conversation { get; }
     IConversationHook SetConversation(Conversation conversation);
 
+    /// <summary>
+    /// Triggered when user connects with agent first time.
+    /// This hook is the good timing to show welcome infomation.
+    /// </summary>
+    /// <param name="conversation"></param>
+    /// <returns></returns>
+    Task OnUserAgentConnectedInitially(Conversation conversation);
+
     /// <summary>
     /// Triggered once for every new conversation.
     /// </summary>

src/Infrastructure/BotSharp.Abstraction/Conversations/IConversationService.cs

@@ -5,6 +5,7 @@ public interface IConversationService
     IConversationStateService States { get; }
     string ConversationId { get; }
     Task<Conversation> NewConversation(Conversation conversation);
+    Task MarkConnectionReady(string conversationId);
     void SetConversationId(string conversationId, List<string> states);
     Task<Conversation> GetConversation(string id);
     Task<List<Conversation>> GetConversations();

src/Infrastructure/BotSharp.Abstraction/Messaging/IRichMessage.cs

@@ -2,5 +2,6 @@ namespace BotSharp.Abstraction.Messaging;
 
 public interface IRichMessage
 {
+    string Type { get; }
     string Text { get; set; }
 }

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/QuickReplyMessage.cs

@@ -1,8 +1,8 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent
 {
-    public class QuickReplyMessage : IRichMessage
+    public class QuickReplyMessage : RichMessageBase, IRichMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "quick reply";
 
         [JsonPropertyName("quick_replies")]
         public List<QuickReplyElement> QuickReplies { get; set; } = new List<QuickReplyElement>();

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ButtonTemplateMessage.cs

@@ -3,12 +3,12 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
     /// <summary>
     /// https://developers.facebook.com/docs/messenger-platform/send-messages/buttons
     /// </summary>
-    public class ButtonTemplateMessage : IRichMessage
+    public class ButtonTemplateMessage : RichMessageBase, IRichMessage, ITemplateMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "template";
 
         [JsonPropertyName("template_type")]
-        public string TemplateType => "button"; 
+        public override string TemplateType => "button"; 
         public List<ButtonElement> Buttons { get; set; } = new List<ButtonElement>();
     }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/CouponTemplateMessage.cs

@@ -4,16 +4,18 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 /// Coupon Template
 /// https://developers.facebook.com/docs/messenger-platform/send-messages/template/coupon
 /// </summary>
-public class CouponTemplateMessage : IRichMessage, ITemplateMessage
+public class CouponTemplateMessage : RichMessageBase, IRichMessage, ITemplateMessage
 {
+    public override string Type => "template";
+
+    [JsonPropertyName("template_type")]
+    public override string TemplateType => "coupon";
+
     [JsonIgnore]
-    public string Text { get; set; }
+    public override string Text { get; set; }
     public string Title { get; set; }
     public string Subtitle { get; set; }
 
-    [JsonPropertyName("template_type")]
-    public string TemplateType => "coupon";
-
     [JsonPropertyName("coupon_code")]
     public string CouponCode { get; set; }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/MultiSelectTemplateMessage.cs

@@ -1,8 +1,8 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
 {
-    public class MultiSelectTemplateMessage : IRichMessage
+    public class MultiSelectTemplateMessage : RichMessageBase, IRichMessage
     {
-        public string Text { get; set; } = string.Empty;
+        public override string Type => "template";
 
         [JsonPropertyName("template_type")]
         public string TemplateType => "multi-select";

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/ProductTemplateMessage.cs

@@ -2,6 +2,7 @@ namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template;
 
 public class ProductTemplateMessage : TemplateMessageBase<ProductElement>, IRichMessage
 {
+    [JsonPropertyName("template_type")]
     public override string TemplateType => "product";
 }
 

src/Infrastructure/BotSharp.Abstraction/Messaging/Models/RichContent/Template/TemplateMessageBase.cs

@@ -1,12 +1,15 @@
 namespace BotSharp.Abstraction.Messaging.Models.RichContent.Template
 {
-    public class TemplateMessageBase<T>
+    public class TemplateMessageBase<T> : RichMessageBase
     {
         [JsonIgnore]
         public string Text { get; set; }
 
+        public override string Type => "template";
+
         [JsonPropertyName("template_type")]
         public virtual string TemplateType => string.Empty;
+
         public T[] Elements { get; set; }
     }
 }