LootLockerMetadataRequestHandler.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "Dom/JsonObject.h"
#include "LootLockerResponse.h"
#include "LootLockerPlayerData.h"
#include "LootLockerMetadataRequestHandler.generated.h"
 
//==================================================
// Enum Definitions
//==================================================

UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerMetadataSources : uint8
{
    reward = 0,
    leaderboard = 1,
    catalog_item = 2,
    progression = 3,
    currency = 4,
    player = 5,
    self = 6,
    asset = 7,
    item = 8, // This is the source for legacy items, while the "inventory_item" source is for item instances
    inventory_item = 9, // This is the source for item instances (player inventory items)
    item_template = 10, // This is the source for item templates
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerMetadataTypes : uint8
{
    String = 0,
    Number = 1,
    Bool = 2,
    Json = 3,
    Base64 = 4,
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerMetadataActions : uint8
{
    Create = 0,
    Update = 1,
    Delete = 2,
    Create_or_Update = 3, // Alias for Upsert (same thing)
    Upsert = 4
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerMetadataParserOutputTypes : 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 = "LootLocker")
struct FLootLockerMetadataBase64Value
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Content_type = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Content = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerMetadataEntry
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Key = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataTypes Type = ELootLockerMetadataTypes::String;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> Tags;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> Access;
    LOOTLOCKERSDK_API bool TryGetValueAsString(FString& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsFloat(float& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsInteger(int& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsBool(bool& Output) const;
    LOOTLOCKERSDK_API bool TryGetRawValue(TSharedPtr<FJsonValue>& Output) const;
    LOOTLOCKERSDK_API bool TryGetSerializedValue(FString& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsJsonObject(TSharedPtr<FJsonObject>& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsJsonArray(TArray<TSharedPtr<FJsonValue>>& Output) const;
    LOOTLOCKERSDK_API bool TryGetValueAsBase64(FLootLockerMetadataBase64Value& Output) const;

    LOOTLOCKERSDK_API void SetValueAsString(const FString& Value);
    LOOTLOCKERSDK_API void SetValueAsFloat(const float& Value);
    LOOTLOCKERSDK_API void SetValueAsInteger(const int& Value);
    LOOTLOCKERSDK_API void SetValueAsBool(const bool& Value);
    LOOTLOCKERSDK_API void SetRawValue(const TSharedPtr<FJsonValue>& Value);
    template<typename T>
    LOOTLOCKERSDK_API bool SetValueAsUStruct(const T& Value);
    LOOTLOCKERSDK_API void SetValueAsJsonObject(const FJsonObject& Value);
    LOOTLOCKERSDK_API void SetValueAsJsonArray(const TArray<TSharedPtr<FJsonValue>>& Value);
    LOOTLOCKERSDK_API void SetValueAsBase64(const FLootLockerMetadataBase64Value& Value);

    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeStringEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FString& Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeFloatEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const float& Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeIntegerEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const int Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeBoolEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const bool Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeJsonValueEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const ELootLockerMetadataTypes Type, const TSharedPtr<FJsonValue> Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeJsonObjectEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FJsonObject& Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeJsonArrayEntry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const TArray<TSharedPtr<FJsonValue>>& Value);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeBase64Entry(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const FLootLockerMetadataBase64Value& Value);

    void LOOTLOCKERSDK_API _INTERNAL_SetJsonRepresentation(const FJsonObject& obj);
    static LOOTLOCKERSDK_API FLootLockerMetadataEntry MakeEntryExceptValue(const FString& Key, const TArray<FString>& Tags, const TArray<FString>& Access, const ELootLockerMetadataTypes Type);
private:
 
    FJsonObject EntryAsJson;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerSetMetadataErrorEntry
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Key = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataTypes Type = ELootLockerMetadataTypes::String;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerSetMetadataError
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataActions Action = ELootLockerMetadataActions::Create;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerSetMetadataErrorEntry Entry;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Error = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerMetadataSourceAndKeys
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataSources Source = ELootLockerMetadataSources::leaderboard;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FString> Keys;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerMetadataSourceAndEntries
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataSources Source = ELootLockerMetadataSources::leaderboard;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Source_id = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMetadataEntry> Entries;
    int LOOTLOCKERSDK_API __INTERNAL_GetEntryIndexByKey(const FString& Key) const;
    void LOOTLOCKERSDK_API __INTERNAL_GenerateKeyMap();
private:
    TMap<FString, int> KeyToEntryIndex = TMap<FString, int>();
};
 
//==================================================
// Request Definitions
//==================================================
USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerGetMultisourceMetadataRequest
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMetadataSourceAndKeys> Sources;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerSetMetadataAction
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataActions Action = ELootLockerMetadataActions::Create;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerMetadataEntry Entry;
};
 
//==================================================
// Response Definitions
//==================================================

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerListMetadataResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMetadataEntry> Entries;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerExtendedIndexBasedPagination Pagination;
    int LOOTLOCKERSDK_API __INTERNAL_GetEntryIndexByKey(const FString& Key) const;
    void LOOTLOCKERSDK_API __INTERNAL_GenerateKeyMap();
private:
    TMap<FString, int> KeyToEntryIndex = TMap<FString, int>();
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerGetMetadataResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerMetadataEntry Entry;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerSetMetadataResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerSetMetadataError> Errors;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerMetadataSources Source = ELootLockerMetadataSources::reward;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Source_id = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerGetMultisourceMetadataResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerMetadataSourceAndEntries> Metadata;
};
 
//==================================================
// Delegate Definitions
//==================================================


DECLARE_DELEGATE_OneParam(FLootLockerListMetadataResponseDelegate, FLootLockerListMetadataResponse);
DECLARE_DELEGATE_OneParam(FLootLockerGetMetadataResponseDelegate, FLootLockerGetMetadataResponse);
DECLARE_DELEGATE_OneParam(FLootLockerGetMultisourceMetadataResponseDelegate, FLootLockerGetMultisourceMetadataResponse);
DECLARE_DELEGATE_OneParam(FLootLockerSetMetadataResponseDelegate, FLootLockerSetMetadataResponse);
 
//==================================================
// API Class Definition
//==================================================

UCLASS()
class LOOTLOCKERSDK_API ULootLockerMetadataRequestHandler : public UObject
{
    GENERATED_BODY()
public:
    ULootLockerMetadataRequestHandler() {};
 
    static FString ListMetadata(const FLootLockerPlayerData& PlayerData, const ELootLockerMetadataSources Source, const FString& SourceID, const int Page, const int PerPage, const FString& Key, const TArray<FString>& Tags, const bool IgnoreFiles, const FLootLockerListMetadataResponseDelegate& OnComplete);
    static FString GetMetadata(const FLootLockerPlayerData& PlayerData, const ELootLockerMetadataSources Source, const FString& SourceID, const FString& Key, const bool IgnoreFiles, const FLootLockerGetMetadataResponseDelegate& OnComplete);
    static FString GetMultisourceMetadata(const FLootLockerPlayerData& PlayerData, const TArray<FLootLockerMetadataSourceAndKeys>& SourcesAndKeysToGet, const bool IgnoreFiles, const FLootLockerGetMultisourceMetadataResponseDelegate& OnComplete);
    static FString SetMetadata(const FLootLockerPlayerData& PlayerData, const ELootLockerMetadataSources Source, const FString& SourceID, const TArray<FLootLockerSetMetadataAction>& MetadataToActionsToPerform, const FLootLockerSetMetadataResponseDelegate& OnComplete);
};