feat: Add support for listing metadata

Author: Erik Bylund

Runtime/Client/LootLockerEndPoints.cs

@@ -292,5 +292,9 @@ public class LootLockerEndPoints
         public static EndPointClass listEntitlementHistory = new EndPointClass("entitlements", LootLockerHTTPMethod.GET);
         public static EndPointClass getSingleEntitlement = new EndPointClass("entitlements/{0}", LootLockerHTTPMethod.GET);
 
+        // Metadata
+        [Header("Metadata")]
+        public static EndPointClass listMetadata = new EndPointClass("metadata/source/{0}/id/{1}", LootLockerHTTPMethod.GET);
+
     }
 }

Runtime/Client/LootLockerServerRequest.cs

@@ -4,7 +4,7 @@
 using LootLocker.LootLockerEnums;
 #if LOOTLOCKER_USE_NEWTONSOFTJSON
 using Newtonsoft.Json;
-using Newtonsoft.Json.Serialization;
+using Newtonsoft.Json.Serialization;
 #else
 using LLlibs.ZeroDepJson;
 #endif
@@ -58,16 +58,16 @@ public static bool TryDeserializeObject<T>(string json, out T output)
         }
 
         public static bool TryDeserializeObject<T>(string json, JsonSerializerSettings options, out T output)
-        {
-            try
-            {
-                output = JsonConvert.DeserializeObject<T>(json, options ?? LootLockerJsonSettings.Default);
-                return true;
-            }
-            catch (Exception)
-            {
-                output = default(T);
-                return false;
+        {
+            try
+            {
+                output = JsonConvert.DeserializeObject<T>(json, options ?? LootLockerJsonSettings.Default);
+                return true;
+            }
+            catch (Exception)
+            {
+                output = default(T);
+                return false;
             }
         }
 #else //LOOTLOCKER_USE_NEWTONSOFTJSON
@@ -97,15 +97,15 @@ public static bool TryDeserializeObject<T>(string json, out T output)
         }
 
         public static bool TryDeserializeObject<T>(string json, JsonOptions options, out T output)
-        {
-            try
-            {
-                output = Json.Deserialize<T>(json, options ?? LootLockerJsonSettings.Default);
-                return true;
-            } catch (Exception)
-            {
-                output = default(T);
-                return false;
+        {
+            try
+            {
+                output = Json.Deserialize<T>(json, options ?? LootLockerJsonSettings.Default);
+                return true;
+            } catch (Exception)
+            {
+                output = default(T);
+                return false;
             }
         }
 #endif //LOOTLOCKER_USE_NEWTONSOFTJSON
@@ -307,6 +307,54 @@ public class LootLockerPaginationResponse<TKey>
         public TKey previous_cursor { get; set; }
     }
 
+    public class LootLockerExtendedPaginationError
+    {
+        /// <summary>
+        /// Which field in the pagination that this error relates to
+        /// </summary>
+        public string field { get; set; }
+        /// <summary>
+        /// The error message in question
+        /// </summary>
+        public string message { get; set; }
+    }
+
+    public class LootLockerExtendedPagination
+    {
+        /// <summary>
+        /// How many entries in total exists in the paginated list
+        /// </summary>
+        public int total { get; set; }
+        /// <summary>
+        /// How many entries (counting from the beginning of the paginated list) from the first entry that the current page starts at
+        /// </summary>
+        public int offset { get; set; }
+        /// <summary>
+        /// Number of entries on each page
+        /// </summary>
+        public int per_page { get; set; }
+        /// <summary>
+        /// The page index to use for fetching the last page of entries
+        /// </summary>
+        public int last_page { get; set; }
+        /// <summary>
+        /// The page index used for fetching this page of entries
+        /// </summary>
+        public int current_page { get; set; }
+        /// <summary>
+        /// The page index to use for fetching the page of entries immediately succeeding this page of entries
+        /// </summary>
+        public int? next_page { get; set; }
+        /// <summary>
+        /// The page index to use for fetching the page of entries immediately preceding this page of entries
+        /// </summary>
+        public int? prev_page { get; set; }
+        /// <summary>
+        /// List of pagination errors (if any). These are errors specifically related to the pagination of the entry set.
+        /// </summary>
+        public LootLockerExtendedPaginationError[] errors { get; set; }
+    }
+
     /// <summary>
     /// Convenience factory class for creating some responses that we use often.
     /// </summary>

Runtime/Game/LootLockerSDKManager.cs

@@ -5769,6 +5769,94 @@ public static void GetEntitlement(string entitlementId, Action<LootLockerSingleE
 
         #endregion
 
+        #region Metadata
+
+        /// <summary>
+        /// List Metadata for the specified source with default pagination
+        /// </summary>
+        /// <param name="Source> The source type for which to request metadata</param>
+        /// <param name="SourceID> The specific source id for which to request metadata</param>
+        /// <param name="OnComplete> delegate for handling the server response</param>
+        /// <param name="IgnoreFiles> Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.</param>
+        public static void ListMetadata(LootLockerMetadataSources Source, string SourceID, Action<LootLockerListMetadataResponse> onComplete, bool IgnoreFiles = false)
+        {
+            ListMetadata(Source, SourceID, 0, 0, onComplete, IgnoreFiles);
+        }
+
+        /// <summary>
+        /// List the requested page of Metadata for the specified source with the specified pagination
+        /// </summary>
+        /// <param name="Source> The source type for which to request metadata</param>
+        /// <param name="SourceID> The specific source id for which to request metadata</param>
+        /// <param name="Page> Used together with PerPage to apply pagination to this request. Page designates which "page" of items to fetch</param>
+        /// <param name="PerPage> Used together with Page to apply pagination to this request.PerPage designates how many items are considered a "page"</param>
+        /// <param name="OnComplete> delegate for handling the server response</param>
+        /// <param name="IgnoreFiles> Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.</param>
+        public static void ListMetadata(LootLockerMetadataSources Source, string SourceID, int Page, int PerPage, Action<LootLockerListMetadataResponse> onComplete, bool IgnoreFiles = false)
+        {
+            ListMetadataWithTags(Source, SourceID, null, Page, PerPage, onComplete, IgnoreFiles);
+        }
+
+        /// <summary>
+        /// List Metadata for the specified source that has all of the provided tags, use default pagination
+        /// </summary>
+        /// <param name="Source> The source type for which to request metadata</param>
+        /// <param name="SourceID> The specific source id for which to request metadata</param>
+        /// <param name="Tags"> The tags that the requested metadata should have, only metadata matching *all of* the given tags will be returned </param>
+        /// <param name="OnComplete> delegate for handling the server response</param>
+        /// <param name="IgnoreFiles> Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.</param>
+        public static void ListMetadataWithTags(LootLockerMetadataSources Source, string SourceID, string[] Tags, Action<LootLockerListMetadataResponse> onComplete, bool IgnoreFiles = false)
+        {
+            ListMetadataWithTags(Source, SourceID, Tags, 0, 0, onComplete, IgnoreFiles);
+        }
+
+        /// <summary>
+        /// List the requested page of Metadata for the specified source that has all of the provided tags and paginate according to the supplied pagination settings
+        /// </summary>
+        /// <param name="Source> The source type for which to request metadata</param>
+        /// <param name="SourceID> The specific source id for which to request metadata</param>
+        /// <param name="Tags"> The tags that the requested metadata should have, only metadata matching *all of* the given tags will be returned </param>
+        /// <param name="Page> Used together with PerPage to apply pagination to this request.Page designates which "page" of items to fetch</param>
+        /// <param name="PerPage> Used together with Page to apply pagination to this request.PerPage designates how many items are considered a "page"</param>
+        /// <param name="OnComplete> delegate for handling the server response</param>
+        /// <param name="IgnoreFiles> Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.</param>
+        public static void ListMetadataWithTags(LootLockerMetadataSources Source, string SourceID, string[] Tags, int Page, int PerPage, Action<LootLockerListMetadataResponse> onComplete, bool IgnoreFiles = false)
+        {
+            if (!CheckInitialized())
+            {
+                onComplete?.Invoke(LootLockerResponseFactory.SDKNotInitializedError<LootLockerListMetadataResponse>());
+                return;
+            }
+
+            LootLockerAPIManager.ListMetadata(Source, SourceID, Page, PerPage, null, Tags, IgnoreFiles, onComplete);
+        }
+
+        /// <summary>
+        /// Get Metadata for the specified source with the given key
+        /// </summary>
+        /// <param name="Source> The source type for which to request metadata</param>
+        /// <param name="SourceID> The specific source id for which to request metadata</param>
+        /// <param name="Key> The key of the metadata to fetch, use this to fetch a specific key for the specified source.This takes precedence over pagination and tags</param>
+        /// <param name="OnComplete> delegate for handling the server response</param>
+        /// <param name="IgnoreFiles> Optional: Base64 values will be set to content_type "application/x-redacted" and the content will be an empty String. Use this to avoid accidentally fetching large data files.</param>
+        public static void GetMetadata(LootLockerMetadataSources Source, string SourceID, string Key, Action<LootLockerGetMetadataResponse> onComplete, bool IgnoreFiles=false)
+        {
+            LootLockerAPIManager.ListMetadata(Source, SourceID, 0, 0, Key, null, IgnoreFiles, (ListResponse) =>
+            {
+                onComplete(new()
+                {
+                    success = ListResponse.success,
+                    statusCode = ListResponse.statusCode,
+                    text = ListResponse.text,
+                    EventId = ListResponse.EventId,
+                    errorData = ListResponse.errorData,
+                    entry = ListResponse.entries != null ? ListResponse.entries.Length > 0 ? ListResponse.entries[0] : null : null
+                });
+            });
+        }
+
+        #endregion
+
         #region Misc
 
         /// <summary>