Some commentary improvements and attachment id is public

Author: Suiram1701

WebUntisAPI.Client/Converter/TimegridJsonConverter.cs

@@ -30,16 +30,16 @@ public override Timegrid ReadJson(JsonReader reader, Type objectType, Timegrid e
         public override void WriteJson(JsonWriter writer, Timegrid value, JsonSerializer serializer)
         {
             writer.WriteStartArray();     // Write the diferent days
-            foreach ((Day day, SchoolHour[] schoolHours) in value)
+            foreach (KeyValuePair<Day, SchoolHour[]> day in value)
             {
                 writer.WriteStartObject();
 
                 writer.WritePropertyName("day");
-                writer.WriteValue((int)day);
+                writer.WriteValue((int)day.Key);
 
                 writer.WritePropertyName("timeUnits");
                 writer.WriteStartArray();     // Write all school hours
-                foreach (SchoolHour hour in schoolHours)
+                foreach (SchoolHour hour in day.Value)
                     serializer.Serialize(writer, hour);
 
                 writer.WriteEndArray();

WebUntisAPI.Client/Models/Messages/Attachment.cs

@@ -20,16 +20,16 @@ namespace WebUntisAPI.Client.Models.Messages
     public struct Attachment
     {
         /// <summary>
-        /// The file name of the attachment
+        /// The attachment id
         /// </summary>
-        [JsonProperty("name")]
-        public string Name { get; set; }
+        [JsonProperty("id")]
+        public string Id { get; set; }
 
         /// <summary>
-        /// The attachment id
+        /// The file name of the attachment
         /// </summary>
-        [JsonProperty("id")]
-        internal readonly string _id;
+        [JsonProperty("name")]
+        public string Name { get; set; }
 
         /// <summary>
         /// Get the content of the attachment as stream with a progress report
@@ -44,7 +44,7 @@ public struct Attachment
         /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
         public async Task<Stream> DownloadContentAsStreamAsync(WebUntisClient client, TimeSpan timeout, IProgress<double> progress = null, CancellationToken ct = default)
         {
-            string storageResponseString = await client.MakeAPIGetRequestAsync($"/WebUntis/api/rest/view/v1/messages/{_id}/attachmentstorageurl", ct);
+            string storageResponseString = await client.MakeAPIGetRequestAsync($"/WebUntis/api/rest/view/v1/messages/{Id}/attachmentstorageurl", ct);
 
             JObject data = JObject.Parse(storageResponseString);
             JArray headerArray = data.Value<JArray>("additionalHeaders");
@@ -85,7 +85,7 @@ public async Task<Stream> DownloadContentAsStreamAsync(WebUntisClient client, Ti
 
                             content.Write(buffer, 0, bytesRead);
                             totalRecievedBytes += bytesRead;
-                            progress.Report((double)totalRecievedBytes / totalBytes * 100d);
+                            progress?.Report((double)totalRecievedBytes / totalBytes * 100d);
                         }
                     }
 

WebUntisAPI.Client/Models/Messages/MessagePermissions.cs

@@ -38,19 +38,19 @@ public class MessagePermissions
         public bool ShowSentTab { get; set; }
 
         /// <summary>
-        /// Can you forbid replies
+        /// Can you forbid replies of a message
         /// </summary>
         [JsonProperty("canForbidReplies")]
         public bool CanForbidReplies { get; set; }
 
         /// <summary>
-        /// The maximum size of a file you could attach in bytes
+        /// The maximum size of a file you could attach to a message in bytes
         /// </summary>
         [JsonProperty("maxFileSize")]
         public long MaxFileSize { get; set; }
 
         /// <summary>
-        /// The maximum count of files you could attach
+        /// The maximum count of files you could attach to one message
         /// </summary>
         [JsonProperty("maxFileCount")]
         public int MaxFileCount { get; set; }

WebUntisAPI.Client/Models/Timegrid.cs

@@ -10,9 +10,9 @@ namespace WebUntisAPI.Client.Models
     /// <summary>
     /// A timegrid for a school
     /// </summary>
-    [DebuggerDisplay("Days = {SchoolDays}")]
+    [DebuggerDisplay("Days = {SchoolDays, nq}")]
     [JsonConverter(typeof(TimegridJsonConverter))]
-    public class Timegrid : IEnumerable<(Day, SchoolHour[])>
+    public class Timegrid : IEnumerable<KeyValuePair<Day, SchoolHour[]>>
     {
         /// <summary>
         /// All the school days with their school hours
@@ -26,7 +26,7 @@ public class Timegrid : IEnumerable<(Day, SchoolHour[])>
 
         #region IEnumerable<SchoolHour[]>
         /// <inheritdoc/>
-        public IEnumerator<(Day, SchoolHour[])> GetEnumerator() => SchoolDays.Keys.Zip(SchoolDays.Values, (day, schoolHours) => (day, schoolHours)).GetEnumerator();
+        public IEnumerator<KeyValuePair<Day, SchoolHour[]>> GetEnumerator() => SchoolDays.GetEnumerator();
 
         IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
         #endregion

WebUntisAPI.Client/WebUntisClient.Messages.cs

@@ -575,7 +575,7 @@ public async Task<DraftPreview> UpdateDraftAsync(Draft draft, Tuple<string, Stre
                 writer.WritePropertyName("attachmentIdsToDelete");
                 writer.WriteStartArray();
                 foreach (Attachment attachment in attachmentToDelete ?? new Attachment[0])
-                    writer.WriteValue(attachment._id);
+                    writer.WriteValue(attachment.Id);
                 writer.WriteEndArray();
 
                 writer.WritePropertyName("forbidReply");