LootLockerServerMetadataRequest.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
#include "CoreMinimal.h"
#include "Dom/JsonObject.h"
#include "Dom/JsonValue.h"
#include "LootLockerServerResponse.h"
#include "LootLockerServerMetadataRequest.generated.h"
 
//==================================================
// Enum Definitions
//==================================================
 
UENUM(BlueprintType, Category = "LootLockerServer")
enum class ELootLockerServerMetadataSources : uint8
{
    reward = 0,
    leaderboard = 1,
    catalog_item = 2,
    progression = 3,
    currency = 4,
    player = 5,
    asset = 6,
    item = 7, // This is the source for legacy items, while the "inventory_item" source is for item instances
    inventory_item = 8, // This is the source for item instances (player inventory items)
    item_template = 9, // This is the source for item templates
};
 
UENUM(BlueprintType, Category = "LootLockerServer")
enum class ELootLockerServerMetadataTypes : uint8
{
    String = 0,
    Number = 1,
    Bool = 2,
    Json = 3,
    Base64 = 4,
};
 
UENUM(BlueprintType, Category = "LootLockerServer")
enum class ELootLockerServerMetadataActions : uint8
{
    Create = 0,
    Update = 1,
    Delete = 2,
    Create_or_Update = 3, // Alias for Upsert (same thing)
    Upsert = 4
};
 
UENUM(BlueprintType, Category = "LootLockerServer")
enum class ELootLockerServerMetadataParserOutputTypes : uint8
{
    OnString = 0 UMETA(ToolTip="Triggered when the parsed entry is of type String. The String Value field will be populated"),
    OnInteger = 1 UMETA(ToolTip = "Triggered when the parsed entry is of type Integer (non decimal number). The Integer Value field will be populated"),
    OnFloat = 2 UMETA(ToolTip = "Triggered when the parsed entry is of type Float (decimal number). The Float Value field will be populated"),
    OnNumber = 3 UMETA(ToolTip = "Triggered when the parsed entry is a number but not a regular integer or float (could for example be too big to fit in either of those types, or the decimal precision is higher than can be solved with either of the types). The NumberString value field will be populated"),
    OnBool = 4 UMETA(ToolTip = "Triggered when the parsed entry is of type Bool. The Bool Value field will be populated"),
    OnJson = 5 UMETA(ToolTip = "Triggered when the parsed entry is of type Json. The JsonString Value field will be populated with the string representation of the json, convert to a JSON object or straight to a USTRUCT of your design"),
    OnBase64 = 6 UMETA(ToolTip = "Triggered when the parsed entry is of type Base64. The Base64 Value field will be populated"),
    OnError = 7 UMETA(ToolTip = "Triggered when the entry could not be parsed. The ErrorMessage Value field will be populated"),
};
 
 
//==================================================
// Data Type Definitions
//==================================================
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerMetadataBase64Value
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Content_type;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Content;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerMetadataEntry
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Key;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataTypes Type = ELootLockerServerMetadataTypes::String;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FString> Tags;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FString> Access;
    /*
     Get the value as a String. Returns true if value could be parsed in which case Output contains the string value untouched, returns false if parsing failed.
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsString(FString& Output) const;
    /*
     Get the value as a float. Returns true if value could be parsed in which case Output contains the float, returns false if parsing failed which can happen if the value is not numeric, the conversion under or overflows, or the string value precision is larger than can be dealt within a float.
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsFloat(float& Output) const;
    /*
     Get the value as an integer. TReturns true if value could be parsed in which case Output contains the int, returns false if parsing failed which can happen if
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsInteger(int& Output) const;
    /*
     Get the value as a boolean. Returns true if value could be parsed in which case Output contains the bool, returns false if parsing failed which can happen if the string is not a convertible to a boolean (those are for example "0", "1", "true", "False", "yes", "NO", etc).
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsBool(bool& Output) const;
    /*
     Get the value as an unparsed json value. Returns true if value could be found in which case Output contains the JsonValue, returns false if the value field was not present.
     */
    LOOTLOCKERSERVERSDK_API bool TryGetRawValue(TSharedPtr<FJsonValue>& Output) const;
    /*
     Get the value in a json string format. Returns true if the value was present and could be serialized, returns false otherwise
     */
    LOOTLOCKERSERVERSDK_API bool TryGetSerializedValue(FString& Output) const;
    /*
     Get the value as a Json Object. Returns true if value could be parsed in which case Output contains the Json Object, returns false if parsing failed which can happen if the value is not a valid json object string.
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsJsonObject(TSharedPtr<FJsonObject>& Output) const;
    /*
     Get the value as a Json Array. Returns true if value could be parsed in which case Output contains the Json Array, returns false if parsing failed which can happen if the value is not a valid json array string
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsJsonArray(TArray<TSharedPtr<FJsonValue>>& Output) const;
    /*
     Get the value as a LootLockerServerMetadataBase64Value object. Returns true if value could be parsed in which case Output contains the FLootLockerServerMetadataBase64Value, returns false if parsing failed.
     */
    LOOTLOCKERSERVERSDK_API bool TryGetValueAsBase64(FLootLockerServerMetadataBase64Value& Output) const;
 
    /*
     Set the value as a String.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsString(const FString& Value);
    /*
     Set the value as a float.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsFloat(const float& Value);
    /*
     Set the value as an integer.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsInteger(const int& Value);
    /*
     Set the value as a bool.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsBool(const bool& Value);
    /*
     Set the value as a JsonValue.
     */
    LOOTLOCKERSERVERSDK_API void SetRawValue(const TSharedPtr<FJsonValue>& Value);
    /*
     Set the value as the provided UStruct object. Returns true if value could be serialized.
     */
    template<typename T>
    LOOTLOCKERSERVERSDK_API bool SetValueAsUStruct(const T& Value);
    /*
     Set the value as a Json Object.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsJsonObject(const FJsonObject& Value);
    /*
     Set the value as a Json Array.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsJsonArray(const TArray<TSharedPtr<FJsonValue>>& Value);
    /*
     Set the value as a Base64 object.
     */
    LOOTLOCKERSERVERSDK_API void SetValueAsBase64(const FLootLockerServerMetadataBase64Value& Value);
 
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a String Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeStringEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FString& Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a Float Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeFloatEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const float& Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with an Integer Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeIntegerEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const int Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a Bool Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeBoolEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const bool Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a JsonValue Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeJsonValueEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const ELootLockerServerMetadataTypes Type, const TSharedPtr<FJsonValue> Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a JsonObject Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeJsonObjectEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FJsonObject& Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a JsonArray Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeJsonArrayEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const TArray<TSharedPtr<FJsonValue>>& Value);
    /*
     Factory method that makes an FLootLockerServerMetadataEntry with a Base64 Value
     */
    static LOOTLOCKERSERVERSDK_API FLootLockerServerMetadataEntry MakeBase64Entry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FLootLockerServerMetadataBase64Value& Value);
 
    /*
     For internal use only
     */
    void LOOTLOCKERSERVERSDK_API _INTERNAL_SetJsonRepresentation(const FJsonObject& obj);
    static FLootLockerServerMetadataEntry LOOTLOCKERSERVERSDK_API _INTERNAL_MakeEntryExceptValue(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const ELootLockerServerMetadataTypes Type);
private:
 
    FJsonObject EntryAsJson;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerSetMetadataErrorEntry
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Key;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataTypes Type = ELootLockerServerMetadataTypes::String;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerSetMetadataError
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataActions Action = ELootLockerServerMetadataActions::Create;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerSetMetadataErrorEntry Entry;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Error;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerMetadataSourceAndKeys
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataSources Source = ELootLockerServerMetadataSources::leaderboard;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FString> Keys;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerMetadataSourceAndEntries
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataSources Source = ELootLockerServerMetadataSources::leaderboard;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Source_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerMetadataEntry> Entries;
    /*
 
     */
    int LOOTLOCKERSERVERSDK_API __INTERNAL_GetEntryIndexByKey(const FString& Key) const;
    /*
 
     */
    void LOOTLOCKERSERVERSDK_API __INTERNAL_GenerateKeyMap();
private:
    TMap<FString, int> KeyToEntryIndex = TMap<FString, int>();
};
 
//==================================================
// Request Definitions
//==================================================
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerSetMetadataAction
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataActions Action = ELootLockerServerMetadataActions::Create;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerMetadataEntry Entry;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerGetMultisourceMetadataRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerMetadataSourceAndKeys> Sources;
};
 
//==================================================
// Response Definitions
//==================================================
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerListMetadataResponse : public FLootLockerServerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerMetadataEntry> Entries;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerExtendedIndexBasedPagination Pagination;
    /*
    Internal Use Only
     */
    int LOOTLOCKERSERVERSDK_API __INTERNAL_GetEntryIndexByKey(const FString Key) const;
    /*
    Internal Use Only
     */
    void LOOTLOCKERSERVERSDK_API __INTERNAL_GenerateKeyMap();
private:
    TMap<FString, int> KeyToEntryIndex = TMap<FString, int>();
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerGetMetadataResponse : public FLootLockerServerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerMetadataEntry Entry;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerSetMetadataResponse : public FLootLockerServerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerSetMetadataError> Errors;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    ELootLockerServerMetadataSources Source = ELootLockerServerMetadataSources::reward;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Source_id;
};
 
USTRUCT(BlueprintType, Category = "LootLockerServer")
struct FLootLockerServerGetMultisourceMetadataResponse : public FLootLockerServerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerMetadataSourceAndEntries> Metadata;
};
 
//==================================================
// C++ Delegate Definitions
//==================================================
 
/*
 C++ response delegate for listing metadata
 */
DECLARE_DELEGATE_OneParam(FLootLockerServerListMetadataResponseDelegate, FLootLockerServerListMetadataResponse);
/*
 C++ response delegate for getting a single metadata entry
 */
DECLARE_DELEGATE_OneParam(FLootLockerServerGetMetadataResponseDelegate, FLootLockerServerGetMetadataResponse);
/*
 Blueprint response delegate for getting multi source metadata
 */
DECLARE_DELEGATE_OneParam(FLootLockerServerGetMultisourceMetadataResponseDelegate, FLootLockerServerGetMultisourceMetadataResponse);
/*
 Blueprint response delegate for setting metadata
 */
DECLARE_DELEGATE_OneParam(FLootLockerServerSetMetadataResponseDelegate, FLootLockerServerSetMetadataResponse);
 
//==================================================
// API Class Definition
//==================================================
 
 
UCLASS()
class LOOTLOCKERSERVERSDK_API ULootLockerServerMetadataRequest : public UObject
{
    GENERATED_BODY()
public:
    ULootLockerServerMetadataRequest();
 
    static FString ListMetadata(const ELootLockerServerMetadataSources Source, const FString& SourceID, const int Page, const int PerPage, const FString& Key, const TArray<FString>& Tags, const bool IgnoreFiles, const FLootLockerServerListMetadataResponseDelegate& OnComplete);
    static FString GetMetadata(const ELootLockerServerMetadataSources Source, const FString& SourceID, const FString& Key, const bool IgnoreFiles, const FLootLockerServerGetMetadataResponseDelegate& OnComplete);
    static FString GetMultisourceMetadata(const TArray<FLootLockerServerMetadataSourceAndKeys>& SourcesAndKeysToGet, const bool IgnoreFiles, const FLootLockerServerGetMultisourceMetadataResponseDelegate& OnComplete);
    static FString SetMetadata(const ELootLockerServerMetadataSources Source, const FString& SourceID, const TArray<FLootLockerServerSetMetadataAction>& MetadataToActionsToPerform, const FLootLockerServerSetMetadataResponseDelegate& OnComplete);
};