Add method to get all available reception people

Author: Suiram1701

API.Test/MessagesTests.cs

@@ -61,4 +61,17 @@ public void GetFullMessage()
         _ = msg.Result;
         return;
     }
+
+    [Test]
+    public void GetReceptionPeople()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<KeyValuePair<string, MessagePerson[]>[]> people = Client.MessageClient.GetMessagePeopleAsync();
+        people.Wait();
+        if (people.Result.Length > 0)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
 }

WebUntisAPI.Client/MessageClient.cs

@@ -35,8 +35,8 @@ public MessageClient(WebUntisClient client)
         /// </summary>
         /// <param name="ct">Cancellation token</param>
         /// <returns>The count of unread messages</returns>
-        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when you're logged in</exception>
+        /// <exception cref="ObjectDisposedException">Thrown when the client instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the client aren't logged in</exception>
         /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
         public async Task<int> GetUnreadMessagesCountAsync(CancellationToken ct = default)
         {
@@ -49,8 +49,8 @@ public async Task<int> GetUnreadMessagesCountAsync(CancellationToken ct = defaul
         /// </summary>
         /// <param name="ct">Cancllation token</param>
         /// <returns></returns>
-        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when you're logged in</exception>
+        /// <exception cref="ObjectDisposedException">Thrown when the client instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the client aren't logged in</exception>
         /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
         public async Task<MessagePermissions> GetMessagePermissionsAsync(CancellationToken ct = default)
         {
@@ -63,8 +63,8 @@ public async Task<MessagePermissions> GetMessagePermissionsAsync(CancellationTok
         /// </summary>
         /// <param name="ct">Cancellation token</param>
         /// <returns>The message previews</returns>
-        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
-        /// <exception cref="UnauthorizedAccessException">Thrown when you're logged in</exception>
+        /// <exception cref="ObjectDisposedException">Thrown when the client instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the client aren't logged in</exception>
         /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
         public async Task<MessagePreview[]> GetMessageInboxAsync(CancellationToken ct = default)
         {
@@ -73,5 +73,25 @@ public async Task<MessagePreview[]> GetMessageInboxAsync(CancellationToken ct =
             JArray jsonMsg = JObject.Parse(responseString).Value<JArray>("incomingMessages");
             return new JsonSerializer().Deserialize<List<MessagePreview>>(jsonMsg.CreateReader()).ToArray();
         }
+
+        /// <summary>
+        /// Get all available reception people
+        /// </summary>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The people (<see cref="KeyValuePair{TKey, TValue}.Key"/> is the type of people that are contained in <see cref="KeyValuePair{TKey, TValue}.Value"/>)</returns>
+        /// <exception cref="ObjectDisposedException">Thrown when the client instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when the client aren't logged in</exception>
+        /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
+        public async Task<KeyValuePair<string, MessagePerson[]>[]> GetMessagePeopleAsync(CancellationToken ct = default)
+        {
+            string responseString = await _client.MakeAPIGetRequestAsync("/WebUntis/api/rest/view/v1/messages/recipients/static/persons", ct);
+
+            List<KeyValuePair<string, MessagePerson[]>> personTypes = new List<KeyValuePair<string, MessagePerson[]>>();
+            JArray types = JArray.Parse(responseString);
+            foreach (JObject personType in types.Cast<JObject>())
+                personTypes.Add(new KeyValuePair<string, MessagePerson[]>(personType.Value<string>("type"),
+                    new JsonSerializer().Deserialize<List<MessagePerson>>(personType.Value<JArray>("persons").CreateReader()).ToArray()));
+            return personTypes.ToArray();
+        }
     }
 }

WebUntisAPI.Client/Models/Message.cs

@@ -36,7 +36,7 @@ public class Message
         /// The sender of the message
         /// </summary>
         [JsonProperty("sender")]
-        public MessageProfile Sender { get; set; }
+        public MessagePerson Sender { get; set; }
 
         /// <summary>
         /// All the recipients for a message
@@ -45,7 +45,7 @@ public class Message
         /// When its <see langword="null"/> is the recipient the current user
         /// </remarks>
         [JsonProperty("recipients")]
-        public List<MessageProfile> Recipients { get; set; } = null;
+        public List<MessagePerson> Recipients { get; set; } = null;
 
         /// <summary>
         /// The send time of the message

…UntisAPI.Client/Models/MessageProfile.cs …bUntisAPI.Client/Models/MessagePerson.csWebUntisAPI.Client/Models/MessageProfile.cs renamed to WebUntisAPI.Client/Models/MessagePerson.cs WebUntisAPI.Client/Models/MessageProfile.cs renamed to WebUntisAPI.Client/Models/MessagePerson.cs

@@ -12,14 +12,20 @@ namespace WebUntisAPI.Client.Models
     /// The user profile at untis messenges
     /// </summary>
     [DebuggerDisplay("{DisplayName, nq}")]
-    public class MessageProfile
+    public class MessagePerson
     {
         /// <summary>
         /// The name of the class from the user
         /// </summary>
         [JsonProperty("className")]
         public string ClassName { get; set; } = null;
 
+        /// <summary>
+        /// Tags of the person
+        /// </summary>
+        [JsonProperty("tags")]
+        public List<string> Tags { get; set; } = new List<string>();
+
         /// <summary>
         /// The displayed name of the user
         /// </summary>

WebUntisAPI.Client/Models/MessagePreview.cs

@@ -42,7 +42,7 @@ public class MessagePreview
         /// The sender of the message
         /// </summary>
         [JsonProperty("sender")]
-        public MessageProfile Sender { get; set; }
+        public MessagePerson Sender { get; set; }
 
         /// <summary>
         /// The send time of the message