LootLockerResponse.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "LootLockerErrorData.h"
#include "LootLockerRequestContext.h"
#include "LootLockerResponse.generated.h"
 
USTRUCT(BlueprintType)
struct FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    bool success = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int StatusCode = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString FullTextFromServer = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerErrorData ErrorData;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerRequestContext Context;
};
 
DECLARE_DELEGATE_OneParam(FLootLockerDefaultDelegate, FLootLockerResponse);
DECLARE_DELEGATE_OneParam(FResponseCallback, FLootLockerResponse);
 
USTRUCT(BlueprintType)
struct FLootLockerKeyBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Next_Cursor = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Previous_Cursor = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerIndexBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Next_Cursor = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Previous_Cursor = 0;
};
 
USTRUCT(BlueprintType)
struct FLootLockerExtendedPaginationError
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Field = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Message = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerExtendedIndexBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Offset = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Per_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Last_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    int32 Current_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Next_page = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Prev_page = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerExtendedPaginationError> Errors;
};
 
struct LootLockerStaticRequestErrorStatusCodes
{
    static const int LL_ERROR_UNDOCUMENTED = 0;
    static const int LL_ERROR_INVALID_HTTP = -1;
    static const int LL_ERROR_INVALID_INPUT = -2;
    static const int LL_ERROR_PARSE_ERROR = -3;
    static const int LL_UNDEFINED_BEHAVIOUR_ERROR = -4;
    static const int LL_ERROR_REQUEST_TIMED_OUT = -5;
    static const int LL_ERROR_SESSION_REFRESH_FAILED = -6;
};
 
class LootLockerResponseFactory
{
public:
    // Construct a standardized error response
    template<typename T>
    static T Error(FString ErrorMessage, int StatusCode = 0, const FString& PlayerUlid = "") 
    {
        T ErrorResponse;
        ErrorResponse.success = false;
        ErrorResponse.StatusCode = StatusCode;
        ErrorResponse.FullTextFromServer = "{ \"message\": \"" + ErrorMessage + "\"}";
        ErrorResponse.ErrorData.Message = ErrorMessage;
        ErrorResponse.Context.PlayerUlid = PlayerUlid;
        
        return ErrorResponse;
    }
 
    // Construct an error response based on an existing error response, but of a different type
    template<typename T>
    static T ErrorFromError(FLootLockerResponse ExistingError) 
    {
        T ErrorResponse;
        ErrorResponse.success = ExistingError.success;
        ErrorResponse.StatusCode = ExistingError.StatusCode;
        ErrorResponse.FullTextFromServer = ExistingError.FullTextFromServer;
        ErrorResponse.ErrorData.Message = ExistingError.ErrorData.Message;
        ErrorResponse.ErrorData.Code = ExistingError.ErrorData.Code;
        ErrorResponse.ErrorData.Doc_url = ExistingError.ErrorData.Doc_url;
        ErrorResponse.ErrorData.Request_id = ExistingError.ErrorData.Request_id;
        ErrorResponse.ErrorData.Trace_id = ExistingError.ErrorData.Trace_id;
        ErrorResponse.ErrorData.Retry_after_seconds = ExistingError.ErrorData.Retry_after_seconds;
        ErrorResponse.Context.PlayerUlid = ExistingError.Context.PlayerUlid;
        ErrorResponse.Context.RequestTime = ExistingError.Context.RequestTime;
        ErrorResponse.Context.RequestId = ExistingError.Context.RequestId;
        ErrorResponse.Context.RequestURL = ExistingError.Context.RequestURL;
        ErrorResponse.Context.RequestMethod = ExistingError.Context.RequestMethod;
        ErrorResponse.Context.RequestParametersJsonString = ExistingError.Context.RequestParametersJsonString;
 
        return ErrorResponse;
    }
};