Merge remote-tracking branch 'origin/2.4' into 2.4

Mirai-NET-Shelter · Mar 2, 2022 · 272b592 · 272b592
2 parents 6b28e50 + 4dba975
commit 272b592
Show file tree

Hide file tree

Showing 51 changed files with 660 additions and 74 deletions.
diff --git a/Mirai.Net.Test/Module1.cs b/Mirai.Net.Test/Module1.cs
@@ -3,7 +3,6 @@
 using Mirai.Net.Data.Messages;
 using Mirai.Net.Data.Messages.Concretes;
 using Mirai.Net.Data.Messages.Receivers;
-using Mirai.Net.Data.Modules;
 using Mirai.Net.Modules;
 using Mirai.Net.Utils.Scaffolds;
 

diff --git a/Mirai.Net/Data/Messages/Concretes/AppMessage.cs b/Mirai.Net/Data/Messages/Concretes/AppMessage.cs
@@ -2,9 +2,18 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 小程序消息
+/// </summary>
 public class AppMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.App;
 
+    /// <summary>
+    /// 消息内容
+    /// </summary>
     [JsonProperty("content")] public string Content { get; set; }
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/AtAllMessage.cs b/Mirai.Net/Data/Messages/Concretes/AtAllMessage.cs
@@ -1,6 +1,12 @@
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// @全体成员
+/// </summary>
 public class AtAllMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.AtAll;
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/AtMessage.cs b/Mirai.Net/Data/Messages/Concretes/AtMessage.cs
@@ -2,13 +2,23 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// @某人
+/// </summary>
 public class AtMessage : MessageBase
 {
+    /// <summary>
+    /// 带参数的构造器
+    /// </summary>
+    /// <param name="target">要@的人的qq</param>
     public AtMessage(string target)
     {
         Target = target;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public AtMessage()
     {
     }
@@ -25,5 +35,8 @@ public AtMessage()
     [JsonProperty("display")]
     internal string Display { get; set; } = "";
 
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.At;
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/DiceMessage.cs b/Mirai.Net/Data/Messages/Concretes/DiceMessage.cs
@@ -2,8 +2,14 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 骰子消息
+/// </summary>
 public class DiceMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Dice;
 
     /// <summary>

diff --git a/Mirai.Net/Data/Messages/Concretes/FaceMessage.cs b/Mirai.Net/Data/Messages/Concretes/FaceMessage.cs
@@ -2,10 +2,13 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// qq表情
+/// </summary>
 public class FaceMessage : MessageBase
 {
     /// <summary>
-    ///     QQ表情编号，可选，优先高于name
+    ///     QQ表情编号，可选，优先高于<see cref="Name"/>
     /// </summary>
     [JsonProperty("faceId")]
     public string FaceId { get; set; }
@@ -16,5 +19,8 @@ public class FaceMessage : MessageBase
     [JsonProperty("name")]
     public string Name { get; set; }
 
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Face;
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/FileMessage.cs b/Mirai.Net/Data/Messages/Concretes/FileMessage.cs
@@ -2,8 +2,14 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 文件
+/// </summary>
 public class FileMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.File;
 
     /// <summary>

diff --git a/Mirai.Net/Data/Messages/Concretes/FlashImageMessage.cs b/Mirai.Net/Data/Messages/Concretes/FlashImageMessage.cs
@@ -1,6 +1,12 @@
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 闪照，构造方式与<see cref="ImageMessage"/>相同
+/// </summary>
 public class FlashImageMessage : ImageMessage
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.FlashImage;
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/ForwardMessage.cs b/Mirai.Net/Data/Messages/Concretes/ForwardMessage.cs
@@ -3,8 +3,14 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 转发的消息
+/// </summary>
 public class ForwardMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Forward;
 
     /// <summary>
@@ -13,6 +19,9 @@ public class ForwardMessage : MessageBase
     [JsonProperty("nodeList")]
     public IEnumerable<ForwardNode> NodeList { get; set; }
 
+    /// <summary>
+    /// 转发的消息节点
+    /// </summary>
     public class ForwardNode
     {
         /// <summary>

diff --git a/Mirai.Net/Data/Messages/Concretes/ImageMessage.cs b/Mirai.Net/Data/Messages/Concretes/ImageMessage.cs
@@ -2,8 +2,14 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 图片
+/// </summary>
 public class ImageMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Image;
 
     /// <summary>

diff --git a/Mirai.Net/Data/Messages/Concretes/JsonMessage.cs b/Mirai.Net/Data/Messages/Concretes/JsonMessage.cs
@@ -2,9 +2,16 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// json消息
+/// </summary>
 public class JsonMessage : MessageBase
 {
+    ///json文本   
     [JsonProperty("json")] public string Json { get; set; }
 
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Json;
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/MarketFaceMessage.cs b/Mirai.Net/Data/Messages/Concretes/MarketFaceMessage.cs
@@ -8,11 +8,20 @@ namespace Mirai.Net.Data.Messages.Concretes;
 /// </summary>
 public class MarketFaceMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.MarketFace;
 
+    /// <summary>
+    /// 表情id
+    /// </summary>
     [JsonProperty("id")]
     public string Id {get; set;}
 
+    /// <summary>
+    /// 表情名称
+    /// </summary>
     [JsonProperty("name")]
     public string Name {get; set;}
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/MiraiCodeMessage.cs b/Mirai.Net/Data/Messages/Concretes/MiraiCodeMessage.cs
@@ -3,8 +3,15 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// Mirai码，
+/// <a href="https://docs.mirai.mamoe.net/mirai-api-http/api/MessageType.html#miraicode">看这里</a>
+/// </summary>
 public class MiraiCodeMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.MiraiCode;
 
     /// <summary>
@@ -13,11 +20,18 @@ public class MiraiCodeMessage : MessageBase
     [JsonProperty("code")]
     public string Code { get; set; }
 
+    /// <summary>
+    /// 带参数的构造器
+    /// </summary>
+    /// <param name="code"></param>
     public MiraiCodeMessage(string code)
     {
         Code = code;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public MiraiCodeMessage()
     {
     }

diff --git a/Mirai.Net/Data/Messages/Concretes/MusicShareMessage.cs b/Mirai.Net/Data/Messages/Concretes/MusicShareMessage.cs
@@ -2,21 +2,48 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 音乐分享
+/// </summary>
 public class MusicShareMessage : MessageBase
 {
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.MusicShare;
 
+    /// <summary>
+    /// 类型
+    /// </summary>
     [JsonProperty("kind")] public string Kind { get; set; }
 
+    /// <summary>
+    /// 标题
+    /// </summary>
     [JsonProperty("title")] public string Title { get; set; }
 
+    /// <summary>
+    /// 概述
+    /// </summary>
     [JsonProperty("summary")] public string Summary { get; set; }
 
+    /// <summary>
+    /// 跳转链接
+    /// </summary>
     [JsonProperty("jumpUrl")] public string JumpUrl { get; set; }
 
+    /// <summary>
+    /// 封面链接
+    /// </summary>
     [JsonProperty("pictureUrl")] public string PictureUrl { get; set; }
 
+    /// <summary>
+    /// 音乐链接
+    /// </summary>
     [JsonProperty("musicUrl")] public string MusicUrl { get; set; }
 
+    /// <summary>
+    /// 简介
+    /// </summary>
     [JsonProperty("brief")] public string Brief { get; set; }
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/PlainMessage.cs b/Mirai.Net/Data/Messages/Concretes/PlainMessage.cs
@@ -2,18 +2,54 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 纯文本消息
+/// </summary>
 public class PlainMessage : MessageBase
 {
+    /// <summary>
+    /// 带参数的构造器
+    /// </summary>
+    /// <param name="text"></param>
     public PlainMessage(string text)
     {
         Text = text;
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
     public PlainMessage()
     {
     }
 
+    /// <summary>
+    /// 文本
+    /// </summary>
     [JsonProperty("text")] public string Text { get; set; }
 
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Plain;
+
+    /// <summary>
+    /// 可以和string相互转换
+    /// </summary>
+    /// <param name="s"></param>
+    /// <returns></returns>
+    public static implicit operator PlainMessage(string s)
+    {
+        return new PlainMessage(s);
+    }
+
+    /// <summary>
+    /// 可以和string相互转换
+    /// </summary>
+    /// <param name="plainMessage"></param>
+    /// <returns></returns>
+    public static implicit operator string(PlainMessage plainMessage)
+    {
+        return plainMessage.Text;
+    }
 }
diff --git a/Mirai.Net/Data/Messages/Concretes/PokeMessage.cs b/Mirai.Net/Data/Messages/Concretes/PokeMessage.cs
@@ -2,6 +2,9 @@
 
 namespace Mirai.Net.Data.Messages.Concretes;
 
+/// <summary>
+/// 我也不知道是啥玩意
+/// </summary>
 public class PokeMessage : MessageBase
 {
     /// <summary>
@@ -15,5 +18,8 @@ public class PokeMessage : MessageBase
     [JsonProperty("name")]
     public string Name { get; set; }
 
+    /// <summary>
+    /// 消息类型
+    /// </summary>
     public override Messages Type { get; set; } = Messages.Poke;
 }