Common
Summary
| Members | Descriptions |
|---|---|
define DECLARE_RH_DELEGATE_BLOCK | Helper for declaring FRH_DelegateBlock types. |
public DECLARE_DYNAMIC_DELEGATE_OneParam(FRH_GenericSuccessDynamicDelegate,bool,bSuccess) | Generic blueprint friendly delegate used to report success or failure. |
public DECLARE_DELEGATE_OneParam(FRH_GenericSuccessDelegate,bool) | Generic native-only delegate used to report success or failure. |
public DECLARE_DYNAMIC_DELEGATE_TwoParams(FRH_GenericSuccessWithErrorDynamicDelegate,bool,bSuccess,const FRH_ErrorInfo &,ErrorInfo) | Generic blueprint friendly delegate used to report success or failure with error info. |
public DECLARE_DELEGATE_TwoParams(FRH_GenericSuccessWithErrorDelegate,bool,const FRH_ErrorInfo &) | Generic native-only delegate used to report success or failure. |
public FORCEINLINE FRH_GenericSuccessWithErrorBlock RH_ConvertGenericSucessDelegateBlock(const FRH_GenericSuccessBlock & InDelegate) | Generic blueprint and native delegate used to report success or failure. |
public DECLARE_DYNAMIC_DELEGATE_OneParam(FRH_CustomEndpointDynamicDelegate,const FRH_CustomEndpointResponseWrapper &,CustomResponseWrapper) | Dynamic delegate used for custom endpoint calls. |
public DECLARE_DELEGATE_OneParam(FRH_CustomEndpointDelegate,const FRH_CustomEndpointResponseWrapper &) | Native delegate used for custom endpoint calls. |
public static bool RH_BreakApartURL(const FString & URL,const FString & BaseURL,FString & APIName,TArray< FString > & APIParams) | Generic blueprint and native delegate used to report success or failure. |
public FORCEINLINE uint32 GetTypeHash(const FRH_PlayerPlatformId & PlatformId) | Helper function to convert an FRH_PlayerPlatformId into a hash value. |
public FORCEINLINE uint32 GetTypeHash(const FRH_RemoteFileApiDirectory & Directory) | Helper function to convert an FRH_RemoteFileApiDirectory into a hash value. |
class FRH_AsyncTaskHelper | Base helper class for asynchronous RallyHere tasks. |
class FRH_SimpleQueryHelper | Templated helper class for asynchronously executing basic RallyHere API queries. |
class FRH_HttpResponseSerializable | |
struct FRH_DelegateBlock | Templated helper class defining a native and blueprint friendly delegate as a single object. |
struct FRH_ErrorInfo | Generic blueprint and native delegate used to report success or failure. |
struct FRH_CustomEndpointRequestWrapper | Wrapper calls for custom endpoint requests. |
struct FRH_CustomEndpointResponseWrapper | Wrapper calls for custom endpoint responses. |
struct FRH_ObjectVersionCheck | An helper object that will take in an desired version check behavior and apply it to a request. |
struct FRH_PlayerPlatformId | Common structure for identifying players on any known platform. |
struct FRH_RemoteFileApiDirectory | A tuple specifying the directory of a file in the remote file storage. |
Members
define DECLARE_RH_DELEGATE_BLOCK
Helper for declaring FRH_DelegateBlock types.
public DECLARE_DYNAMIC_DELEGATE_OneParam(FRH_GenericSuccessDynamicDelegate,bool,bSuccess)
Generic blueprint friendly delegate used to report success or failure.
public DECLARE_DELEGATE_OneParam(FRH_GenericSuccessDelegate,bool)
Generic native-only delegate used to report success or failure.
public DECLARE_DYNAMIC_DELEGATE_TwoParams(FRH_GenericSuccessWithErrorDynamicDelegate,bool,bSuccess,const FRH_ErrorInfo &,ErrorInfo)
Generic blueprint friendly delegate used to report success or failure with error info.
public DECLARE_DELEGATE_TwoParams(FRH_GenericSuccessWithErrorDelegate,bool,const FRH_ErrorInfo &)
Generic native-only delegate used to report success or failure.
public FORCEINLINE FRH_GenericSuccessWithErrorBlock RH_ConvertGenericSucessDelegateBlock(const FRH_GenericSuccessBlock & InDelegate)
Generic blueprint and native delegate used to report success or failure.
public DECLARE_DYNAMIC_DELEGATE_OneParam(FRH_CustomEndpointDynamicDelegate,const FRH_CustomEndpointResponseWrapper &,CustomResponseWrapper)
Dynamic delegate used for custom endpoint calls.
public DECLARE_DELEGATE_OneParam(FRH_CustomEndpointDelegate,const FRH_CustomEndpointResponseWrapper &)
Native delegate used for custom endpoint calls.
public static bool RH_BreakApartURL(const FString & URL,const FString & BaseURL,FString & APIName,TArray< FString > & APIParams)
Generic blueprint and native delegate used to report success or failure.
Helper function to break a fully qualified URL into a base URL, API name, and an array of API parameters
Parameters
-
URLThe fully qualified URL that we want to break apart -
BaseURLThe base URL of the specified fully qualified URL -
APINameThe name of the API the URL is hitting -
APIParamsThe array of API parameters from the URL
Returns
Semi-unique hash value for the given platform id
public FORCEINLINE uint32 GetTypeHash(const FRH_PlayerPlatformId & PlatformId)
Helper function to convert an FRH_PlayerPlatformId into a hash value.
Parameters
PlatformIdThe platform id to generate a hash for
Returns
Semi-unique hash value for the given platform id
public FORCEINLINE uint32 GetTypeHash(const FRH_RemoteFileApiDirectory & Directory)
Helper function to convert an FRH_RemoteFileApiDirectory into a hash value.
Parameters
DirectoryThe directory to generate a hash for
Returns
Semi-unique hash value for the given directory
class FRH_AsyncTaskHelper
class FRH_AsyncTaskHelper
: public TSharedFromThis< FRH_AsyncTaskHelper >
Base helper class for asynchronous RallyHere tasks.
Summary
| Members | Descriptions |
|---|---|
public inline FORCEINLINE bool IsRunning() const | Returns whether or not the task is currently executing. |
public FString GetName() const | Abstract function for fetching the name of the asynchronous task. |
public inline FORCEINLINE int32 GetTaskPriority() const | Gets the TaskPriority. |
public inline FORCEINLINE FTimespan GetDuration() const | Gets the Duration the task has been running for. |
protected int32 TaskPriority | |
protected FDateTime StartedTime | |
protected FDateTime EndedTime | |
protected inline FRH_AsyncTaskHelper() | Default constructor. |
protected inline FRH_AsyncTaskHelper(int32 InPriority) | Constructor with a priority for the task helper. |
protected virtual ~FRH_AsyncTaskHelper() = default | Default destructor. |
protected void ExecuteCallback(bool bSuccess) const | Abstract function called when the asynchronous tasks completes regardless of success or failure. |
protected inline virtual void Cleanup() | Function called to do cleanup when the asynchronous tasks is about to be deleted. |
protected inline void Started() | Function called when the asynchronous task has started. |
protected inline void Failed(const FString & FailureReason) | Function called in the event that the asynchronous task has failed. |
protected inline virtual void Cancel(const FString & CancelReason) | Cancels the asynchronous task by failing it out. |
protected inline void Completed(bool bSuccess) | Called when the asynchronous task has completed. |
Members
public inline FORCEINLINE bool IsRunning() const
Returns whether or not the task is currently executing.
public FString GetName() const
Abstract function for fetching the name of the asynchronous task.
public inline FORCEINLINE int32 GetTaskPriority() const
Gets the TaskPriority.
public inline FORCEINLINE FTimespan GetDuration() const
Gets the Duration the task has been running for.
protected int32 TaskPriority
protected FDateTime StartedTime
protected FDateTime EndedTime
protected inline FRH_AsyncTaskHelper()
Default constructor.
protected inline FRH_AsyncTaskHelper(int32 InPriority)
Constructor with a priority for the task helper.
protected virtual ~FRH_AsyncTaskHelper() = default
Default destructor.
protected void ExecuteCallback(bool bSuccess) const
Abstract function called when the asynchronous tasks completes regardless of success or failure.
protected inline virtual void Cleanup()
Function called to do cleanup when the asynchronous tasks is about to be deleted.
protected inline void Started()
Function called when the asynchronous task has started.
protected inline void Failed(const FString & FailureReason)
Function called in the event that the asynchronous task has failed.
protected inline virtual void Cancel(const FString & CancelReason)
Cancels the asynchronous task by failing it out.
Parameters
CancelReasonTracking string pushed to log for debugging purposes.
This is intended to be called from external code, not from within the task itself. It will just immediately fail, but this is virtual in case any locking etc needs to be done for safety.
protected inline void Completed(bool bSuccess)
Called when the asynchronous task has completed.
Parameters
bSuccessWhether or not the task completed successfully.
class FRH_SimpleQueryHelper
class FRH_SimpleQueryHelper
: public FRH_AsyncTaskHelper
Templated helper class for asynchronously executing basic RallyHere API queries.
Summary
| Members | Descriptions |
|---|---|
public inline FRH_SimpleQueryHelper(const typename BaseType::Delegate & InUpdateDelegate,const FRH_GenericSuccessWithErrorBlock & InCompleteDelegate,int32 InPriority) | Constructor allowing for the specification of callback delegates. |
public inline FRH_SimpleQueryHelper(const typename BaseType::Delegate & InUpdateDelegate,const FRH_GenericSuccessBlock & InCompleteDelegate,int32 InPriority) | Constructor allowing for the specification of callback delegates. |
public inline virtual void Start(TSharedRef< typename BaseType::API > API,const typename BaseType::Request & Request) | Begins the task of asynchronously querying the API. |
public inline void OnQueryComplete(const typename BaseType::Response & Resp) | Called once the asynchronous query has returned a response. |
public inline virtual FString GetName() const | Gets the templated name for this object. |
public inline virtual void ExecuteCallback(bool bSuccess) const | Executes the generic delegate associated with this asynchronous task forwarding bSuccess. |
protected BaseType::Delegate UpdateDelegate | Templated delegate to call with the API's response if query successfully completes. |
protected FRH_GenericSuccessWithErrorBlock Delegate | Generic completion delegate called regardless of success or failure. |
protected FHttpRequestPtr HttpRequest | The HTTP request object used to query the API. |
protected FRH_ErrorInfo ErrorInfo | Error Information |
Members
public inline FRH_SimpleQueryHelper(const typename BaseType::Delegate & InUpdateDelegate,const FRH_GenericSuccessWithErrorBlock & InCompleteDelegate,int32 InPriority)
Constructor allowing for the specification of callback delegates.
Parameters
-
InUpdateDelegateTemplated delegate to call with the API's response if query successfully completes -
InCompleteDelegateGeneric completion delegate called regardless of success or failure
public inline FRH_SimpleQueryHelper(const typename BaseType::Delegate & InUpdateDelegate,const FRH_GenericSuccessBlock & InCompleteDelegate,int32 InPriority)
Constructor allowing for the specification of callback delegates.
Parameters
-
InUpdateDelegateTemplated delegate to call with the API's response if query successfully completes -
InCompleteDelegateGeneric completion delegate called regardless of success or failure
public inline virtual void Start(TSharedRef< typename BaseType::API > API,const typename BaseType::Request & Request)
Begins the task of asynchronously querying the API.
Parameters
-
APIAPI target for the query (i.e. User, Session, Inventory, etc.) -
RequestTemplated request data for the query -
PriorityThe Priority of the call, lower is higher priority
public inline void OnQueryComplete(const typename BaseType::Response & Resp)
Called once the asynchronous query has returned a response.
Parameters
RespTemplated response data for the query
public inline virtual FString GetName() const
Gets the templated name for this object.
public inline virtual void ExecuteCallback(bool bSuccess) const
Executes the generic delegate associated with this asynchronous task forwarding bSuccess.
protected BaseType::Delegate UpdateDelegate
Templated delegate to call with the API's response if query successfully completes.
protected FRH_GenericSuccessWithErrorBlock Delegate
Generic completion delegate called regardless of success or failure.
protected FHttpRequestPtr HttpRequest
The HTTP request object used to query the API.
protected FRH_ErrorInfo ErrorInfo
Error Information
class FRH_HttpResponseSerializable
class FRH_HttpResponseSerializable
: public IHttpResponse
Summary
| Members | Descriptions |
|---|---|
public inline FRH_HttpResponseSerializable() | Default constructor. |
public inline FRH_HttpResponseSerializable(const FHttpResponsePtr & InHttpResponse) | Constructor that takes a response pointer to serialize. |
public virtual bool ExportToFile(const FString & FilePath,bool bCanCompress) const | Exports the contents of the response to a file. |
public virtual bool ImportFromFile(const FString & FilePath) | Imports the contents of the response from a file. |
public inline virtual int32 GetResponseCode() const | Gets the response code returned by the requested server. See EHttpResponseCodes for known response codes. |
public inline virtual FString GetContentAsString() const | Returns the payload as a string, assuming the payload is UTF8. |
public inline virtual FString GetURL() const | Get the URL used to send the request. |
public inline virtual FString GetURLParameter(const FString & ParameterName) const | Gets an URL parameter. expected format is ?Key=Value&Key=Value... If that format is not used, this function will not work. |
public inline virtual FString GetHeader(const FString & HeaderName) const | Gets the value of a header, or empty string if not found. |
public inline virtual TArray< FString > GetAllHeaders() const | Return all headers in an array in "Name: Value" format. |
public inline virtual FString GetContentType() const | Shortcut to get the Content-Type header value (if available) |
public inline virtual uint64 GetContentLength() const | Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length. |
public inline virtual const TArray< uint8 > & GetContent() const | Get the content payload of the request or response. |
protected int32 ResponseCode | The http response code. |
protected FString URL | The URL used to send the request. |
protected TMap< FString, FString > URLParameters | The URL parameters for the request. |
protected int64 ContentLength | The content length of the response. |
protected FString ContentType | The content type of the response. |
protected TArray< FString > Headers | The headers of the response. |
protected TArray< uint8 > Content | The content of the response. |
Members
public inline FRH_HttpResponseSerializable()
Default constructor.
public inline FRH_HttpResponseSerializable(const FHttpResponsePtr & InHttpResponse)
Constructor that takes a response pointer to serialize.
Parameters
InHttpResponseThe response pointer to use.
public virtual bool ExportToFile(const FString & FilePath,bool bCanCompress) const
Exports the contents of the response to a file.
Parameters
-
FilePathThe file path to export the response to. -
bCanCompressWhether the content can be compressed.
Returns
Whether the export was successful.
public virtual bool ImportFromFile(const FString & FilePath)
Imports the contents of the response from a file.
Parameters
FilePathThe file path to import the response from.
Returns
Whether the import was successful.
public inline virtual int32 GetResponseCode() const
Gets the response code returned by the requested server. See EHttpResponseCodes for known response codes.
Returns
the response code.
public inline virtual FString GetContentAsString() const
Returns the payload as a string, assuming the payload is UTF8.
Returns
the payload as a string.
public inline virtual FString GetURL() const
Get the URL used to send the request.
Returns
the URL string.
public inline virtual FString GetURLParameter(const FString & ParameterName) const
Gets an URL parameter. expected format is ?Key=Value&Key=Value... If that format is not used, this function will not work.
Parameters
ParameterName- the parameter to request.
Returns
the parameter value string.
public inline virtual FString GetHeader(const FString & HeaderName) const
Gets the value of a header, or empty string if not found.
Parameters
HeaderName- name of the header to set.
public inline virtual TArray< FString > GetAllHeaders() const
Return all headers in an array in "Name: Value" format.
Returns
the header array of strings
public inline virtual FString GetContentType() const
Shortcut to get the Content-Type header value (if available)
Returns
the content type.
public inline virtual uint64 GetContentLength() const
Shortcut to get the Content-Length header value. Will not always return non-zero. If you want the real length of the payload, get the payload and check it's length.
Returns
the content length (if available)
public inline virtual const TArray< uint8 > & GetContent() const
Get the content payload of the request or response.
protected int32 ResponseCode
The http response code.
protected FString URL
The URL used to send the request.
protected TMap< FString, FString > URLParameters
The URL parameters for the request.
protected int64 ContentLength
The content length of the response.
protected FString ContentType
The content type of the response.
protected TArray< FString > Headers
The headers of the response.
protected TArray< uint8 > Content
The content of the response.
struct FRH_DelegateBlock
Templated helper class defining a native and blueprint friendly delegate as a single object.
Summary
| Members | Descriptions |
|---|---|
public DelegateType Delegate | Native-only version of the delegate. |
public DynamicDelegateType DynDelegate | Blueprint friendly version of the delegate. |
public inline FRH_DelegateBlock() | Default constructor leaving both delegates unbound. |
public inline FRH_DelegateBlock(const DelegateType & InDelegate) | Constructor for binding just the native-only version of the delegate. |
public inline FRH_DelegateBlock(const DynamicDelegateType & InDynDelegate) | Constructor for binding just the blueprint friendly version of the delegate. |
public inline void ExecuteIfBound(ParamList... params) const | Executes both the native-only and blueprint friendly versions of the delegate, if they're bound. |
public inline bool IsBound() const | |
public inline bool IsBoundToObject(const void * Object) const |
Members
public DelegateType Delegate
Native-only version of the delegate.
public DynamicDelegateType DynDelegate
Blueprint friendly version of the delegate.
public inline FRH_DelegateBlock()
Default constructor leaving both delegates unbound.
public inline FRH_DelegateBlock(const DelegateType & InDelegate)
Constructor for binding just the native-only version of the delegate.
public inline FRH_DelegateBlock(const DynamicDelegateType & InDynDelegate)
Constructor for binding just the blueprint friendly version of the delegate.
public inline void ExecuteIfBound(ParamList... params) const
Executes both the native-only and blueprint friendly versions of the delegate, if they're bound.
public inline bool IsBound() const
public inline bool IsBoundToObject(const void * Object) const
struct FRH_ErrorInfo
Generic blueprint and native delegate used to report success or failure.
Generic handler for HTTP request errors.
Summary
| Members | Descriptions |
|---|---|
public FHttpResponsePtr HttpResponse | The raw http response. |
public int32 ResponseCode | The Error Code of the HTTP request. |
public FString ResponseContent | Content of the HTTP request response. |
public bool bIsRHCommonError | Whether the response is a RallyHere common error. |
public FRHAPI_HzApiErrorModel RHCommonError | The response as a RallyHere common error. |
public bool bIsRHValidationError | Whether the response is a RallyHere validation error. |
public FRHAPI_ValidationError RHValidationError | The response as a RallyHere validation error. |
public inline FRH_ErrorInfo() | Default constructor. |
public inline FRH_ErrorInfo(const RallyHereAPI::FResponse * Response) | Construct from Response Ptr. |
public inline FRH_ErrorInfo(const RallyHereAPI::FResponse & Response) | Construct from Response Ref. |
public virtual ~FRH_ErrorInfo() = default | Default destructor. |
public inline void ImportErrorInfo(const RallyHereAPI::FResponse & Response) | Parses The HTTP response into the error info. |
Members
public FHttpResponsePtr HttpResponse
The raw http response.
public int32 ResponseCode
The Error Code of the HTTP request.
public FString ResponseContent
Content of the HTTP request response.
public bool bIsRHCommonError
Whether the response is a RallyHere common error.
public FRHAPI_HzApiErrorModel RHCommonError
The response as a RallyHere common error.
public bool bIsRHValidationError
Whether the response is a RallyHere validation error.
public FRHAPI_ValidationError RHValidationError
The response as a RallyHere validation error.
public inline FRH_ErrorInfo()
Default constructor.
public inline FRH_ErrorInfo(const RallyHereAPI::FResponse * Response)
Construct from Response Ptr.
public inline FRH_ErrorInfo(const RallyHereAPI::FResponse & Response)
Construct from Response Ref.
public virtual ~FRH_ErrorInfo() = default
Default destructor.
public inline void ImportErrorInfo(const RallyHereAPI::FResponse & Response)
Parses The HTTP response into the error info.
Parameters
ResponseThe response to parse.
struct FRH_CustomEndpointRequestWrapper
Wrapper calls for custom endpoint requests.
Summary
| Members | Descriptions |
|---|---|
public FString EndpointId | Http Endpoint ID that is mapped to a URL |
public int32 Priority | Call Priority |
public FRHAPI_JsonValue Body | Http Body as Json |
public FString ContentType | Http Content Type |
public inline FRH_CustomEndpointRequestWrapper() |
Members
public FString EndpointId
Http Endpoint ID that is mapped to a URL
public int32 Priority
Call Priority
public FRHAPI_JsonValue Body
Http Body as Json
public FString ContentType
Http Content Type
public inline FRH_CustomEndpointRequestWrapper()
struct FRH_CustomEndpointResponseWrapper
Wrapper calls for custom endpoint responses.
Summary
| Members | Descriptions |
|---|---|
public int32 HttpResponseCode | Http Response Code |
public TArray< FString > HttpHeaders | Http Headers |
public FRHAPI_JsonValue HttpBody | Http Body as Json |
public FRH_ErrorInfo RHErrorInfo | Parsed RallyHere error |
public inline FRH_CustomEndpointResponseWrapper() | |
public inline FRH_CustomEndpointResponseWrapper(const RallyHereAPI::FResponse_CustomEndpointSend & Resp) |
Members
public int32 HttpResponseCode
Http Response Code
public TArray< FString > HttpHeaders
Http Headers
public FRHAPI_JsonValue HttpBody
Http Body as Json
public FRH_ErrorInfo RHErrorInfo
Parsed RallyHere error
public inline FRH_CustomEndpointResponseWrapper()
public inline FRH_CustomEndpointResponseWrapper(const RallyHereAPI::FResponse_CustomEndpointSend & Resp)
struct FRH_ObjectVersionCheck
An helper object that will take in an desired version check behavior and apply it to a request.
Summary
| Members | Descriptions |
|---|---|
public FString IfMatch | The value to be passed in the IfMatch header |
public FString IfNoneMatch | The value to be passed in the IfNoneMatch header |
public FString IfModifiedSince | The value to be passed in the IfModifiedSince header, must be in HttpDate format (see FDateTime::ToHttpDate()) |
public FString IfNotModifiedSince | The value to be passed in the IfUnmodifiedSince header, must be in HttpDate format (see FDateTime::ToHttpDate()) |
public GENERATED_USTRUCT_BODY() | |
public inline FRH_ObjectVersionCheck(const FString & InIfMatch,const FString & InIfNoneMatch,const FString & InIfModifiedSince,const FString & InIfNotModifiedSince) | |
public template<> inline void ApplyToRequest(T & InRequest) const | Apply the version check behavior to a request. |
Members
public FString IfMatch
The value to be passed in the IfMatch header
public FString IfNoneMatch
The value to be passed in the IfNoneMatch header
public FString IfModifiedSince
The value to be passed in the IfModifiedSince header, must be in HttpDate format (see FDateTime::ToHttpDate())
public FString IfNotModifiedSince
The value to be passed in the IfUnmodifiedSince header, must be in HttpDate format (see FDateTime::ToHttpDate())
public GENERATED_USTRUCT_BODY()
public inline FRH_ObjectVersionCheck(const FString & InIfMatch,const FString & InIfNoneMatch,const FString & InIfModifiedSince,const FString & InIfNotModifiedSince)
public template<>
inline void ApplyToRequest(T & InRequest) const
Apply the version check behavior to a request.
struct FRH_PlayerPlatformId
Common structure for identifying players on any known platform.
Summary
| Members | Descriptions |
|---|---|
public FString UserId | Player identifier for the given platform type. |
public ERHAPI_Platform PlatformType | Platform type of this identifier. |
public inline FORCEINLINE bool IsValid() const | Returns whether or not this player platform ID has been filled with sensible data. |
public inline bool operator==(const FRH_PlayerPlatformId & Other) const | Returns whether or not this player platform ID exactly matches the given player platform ID. |
public inline FRH_PlayerPlatformId() | Default constructor that leaves the user ID empty and sets the platform type to "unknown". |
public inline FRH_PlayerPlatformId(const FString & InUserId,ERHAPI_Platform InPlatformType) | Constructor for specifying user ID and platform type. |
Members
public FString UserId
Player identifier for the given platform type.
public ERHAPI_Platform PlatformType
Platform type of this identifier.
public inline FORCEINLINE bool IsValid() const
Returns whether or not this player platform ID has been filled with sensible data.
public inline bool operator==(const FRH_PlayerPlatformId & Other) const
Returns whether or not this player platform ID exactly matches the given player platform ID.
public inline FRH_PlayerPlatformId()
Default constructor that leaves the user ID empty and sets the platform type to "unknown".
public inline FRH_PlayerPlatformId(const FString & InUserId,ERHAPI_Platform InPlatformType)
Constructor for specifying user ID and platform type.
struct FRH_RemoteFileApiDirectory
A tuple specifying the directory of a file in the remote file storage.
Summary
| Members | Descriptions |
|---|---|
public ERHAPI_FileType FileType | The type of file to upload/download |
public ERHAPI_EntityType EntityType | The type of entity the file is associated with |
public FString EntityId | The id of the entity the file is associated with |
public GENERATED_USTRUCT_BODY() | |
public inline FRH_RemoteFileApiDirectory() | |
public inline FRH_RemoteFileApiDirectory(ERHAPI_FileType InFileType,ERHAPI_EntityType InEntityType,const FString & InEntityId) | |
public inline bool operator==(const FRH_RemoteFileApiDirectory & Other) const | Comparison operator. |
public inline bool IsValid() const | |
public inline FString ToDescriptionString() const | Get a string representation of the directory. |
Members
public ERHAPI_FileType FileType
The type of file to upload/download
public ERHAPI_EntityType EntityType
The type of entity the file is associated with
public FString EntityId
The id of the entity the file is associated with
public GENERATED_USTRUCT_BODY()
public inline FRH_RemoteFileApiDirectory()
public inline FRH_RemoteFileApiDirectory(ERHAPI_FileType InFileType,ERHAPI_EntityType InEntityType,const FString & InEntityId)
public inline bool operator==(const FRH_RemoteFileApiDirectory & Other) const
Comparison operator.
public inline bool IsValid() const
public inline FString ToDescriptionString() const
Get a string representation of the directory.
Returns
A string representation of the directory