A Demo Project for the UnrealEngineSDK
Loading...
Searching...
No Matches
Static Public Member Functions | Private Member Functions | List of all members
UVaRestLibrary Class Reference

UCLASS() More...

#include <VaRestLibrary.h>

Inheritance diagram for UVaRestLibrary:
[legend]

Static Public Member Functions

static bool Base64Decode (const FString &Source, FString &Dest)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Decode"))
 
static bool Base64DecodeData (const FString &Source, TArray< uint8 > &Dest)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Decode Data"))
 
static FString Base64Encode (const FString &Source)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Encode"))
 
static bool Base64EncodeData (const TArray< uint8 > &Data, FString &Dest)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Encode Data"))
 
static UVaRestSettings * GetVaRestSettings ()
 UFUNCTION(BlueprintPure, Category = "VaRest|Common")
 
static FString GetVaRestVersion ()
 UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (DisplayName = "Get VaRest Version"))
 
static FVaRestURL GetWorldURL (UObject *WorldContextObject)
 UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (WorldContext = "WorldContextObject"))
 
static FORCEINLINE EVaRestHttpStatusCode::Type HTTPStatusIntToEnum (int32 StatusCode)
 UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (DisplayName = "HTTP Status Int To Enum"))
 
static FString PercentEncode (const FString &Source)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility")
 
static FString StringToMd5 (const FString &StringToHash)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to MD5"))
 
static FString StringToSha1 (const FString &StringToHash)
 UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to SHA1"))
 

Private Member Functions

 GENERATED_BODY ()
 

Detailed Description

UCLASS()

Useful tools for REST communications

Definition at line 19 of file VaRestLibrary.h.

Member Function Documentation

◆ Base64Decode()

bool UVaRestLibrary::Base64Decode ( const FString & Source,
FString & Dest )
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Decode"))

Decodes a Base64 string into a FString

Parameters
SourceThe stringified data to convert
DestThe out buffer that will be filled with the decoded data
Returns
True if the buffer was decoded, false if it failed to decode

Definition at line 33 of file VaRestLibrary.cpp.

◆ Base64DecodeData()

bool UVaRestLibrary::Base64DecodeData ( const FString & Source,
TArray< uint8 > & Dest )
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Decode Data"))

Decodes a Base64 string into a byte array

Parameters
SourceThe stringified data to convert
DestThe out buffer that will be filled with the decoded data
Returns
True if the buffer was decoded, false if it failed to decode

Definition at line 57 of file VaRestLibrary.cpp.

◆ Base64Encode()

FString UVaRestLibrary::Base64Encode ( const FString & Source)
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Encode"))

Encodes a FString into a Base64 string

Parameters
SourceThe string data to convert
Returns
A string that encodes the binary data in a way that can be safely transmitted via various Internet protocols

Definition at line 24 of file VaRestLibrary.cpp.

◆ Base64EncodeData()

bool UVaRestLibrary::Base64EncodeData ( const TArray< uint8 > & Data,
FString & Dest )
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Encode Data"))

Encodes a byte array into a Base64 string

Parameters
DaraThe data to convert
Returns
A string that encodes the binary data in a way that can be safely transmitted via various Internet protocols

Definition at line 45 of file VaRestLibrary.cpp.

◆ GENERATED_BODY()

UVaRestLibrary::GENERATED_BODY ( )
private

◆ GetVaRestSettings()

UVaRestSettings * UVaRestLibrary::GetVaRestSettings ( )
staticBlueprintPure

UFUNCTION(BlueprintPure, Category = "VaRest|Common")

Direct access to the plugin settings

Definition at line 14 of file VaRestLibrary.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetVaRestVersion()

FString UVaRestLibrary::GetVaRestVersion ( )
staticBlueprintPure

UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (DisplayName = "Get VaRest Version"))

Get the plugin's version

Definition at line 83 of file VaRestLibrary.cpp.

Here is the caller graph for this function:

◆ GetWorldURL()

FVaRestURL UVaRestLibrary::GetWorldURL ( UObject * WorldContextObject)
staticBlueprintPure

UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (WorldContext = "WorldContextObject"))

Get the URL that was used when loading this World

Definition at line 90 of file VaRestLibrary.cpp.

◆ HTTPStatusIntToEnum()

static FORCEINLINE EVaRestHttpStatusCode::Type UVaRestLibrary::HTTPStatusIntToEnum ( int32 StatusCode)
inlinestaticBlueprintPure

UFUNCTION(BlueprintPure, Category = "VaRest|Utility", meta = (DisplayName = "HTTP Status Int To Enum"))

Helper method to convert a status code from HTTP to an enum for easier readability

Definition at line 121 of file VaRestLibrary.h.

◆ PercentEncode()

FString UVaRestLibrary::PercentEncode ( const FString & Source)
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility")

Applies percent-encoding to text

Definition at line 19 of file VaRestLibrary.cpp.

Here is the caller graph for this function:

◆ StringToMd5()

FString UVaRestLibrary::StringToMd5 ( const FString & StringToHash)
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to MD5"))

Helper to perform the very common case of hashing an ASCII string into a hex representation.

Parameters
StringHex representation of the hash (32 lower-case hex digits)

Definition at line 62 of file VaRestLibrary.cpp.

◆ StringToSha1()

FString UVaRestLibrary::StringToSha1 ( const FString & StringToHash)
staticBlueprintCallable

UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to SHA1"))

Helper to perform the SHA1 hash operation on string.

Definition at line 67 of file VaRestLibrary.cpp.

The documentation for this class was generated from the following files: