Loading...
Searching...
No Matches
AccelByte::FHttpClient Class Referencefinal

HTTP client for building API. More...

#include <AccelByteHttpClient.h>

Public Member Functions

 FHttpClient (BaseCredentials const &InCredentialsRef, BaseSettings const &InSettingsRef, FHttpRetrySchedulerBase &InHttpRef)
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FString const &Content, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, TArray< uint8 > const &Content, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FString const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, TArray< uint8 > const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, FString const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TArray< uint8 > const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TMap< FString, FString > const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TSharedPtr< FJsonObject > JsonObject, TMap< FString, FString > const &Headers, U const &OnSuccess, V const &OnError, bool bOmitBlankValues=false)
 Basic HTTP request.
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TArray< uint8 > const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, V const &OnError)
template<typename U, typename V>
FAccelByteTaskPtr Request (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, FString const &Content, TMap< FString, FString > const &Headers, U const &OnSuccess, FHttpRequestProgressDelegate const &OnProgress, V const &OnError)
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TMap< FString, FString > const &Data, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, FString const &Json, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TSharedRef< FJsonObject > const &Json, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename T, typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, T const &UStruct, U const &OnSuccess, V const &OnError, bool bOmitBlankValues=false)
 API request with credentials access token (if available).
template<typename T, typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, T const &UStruct, TMap< FString, FString > &Headers, U const &OnSuccess, V const &OnError, bool bOmitBlankValues=false)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TSharedPtr< FJsonObject > const &JsonObject, U const &OnSuccess, V const &OnError, bool bOmitBlankValues=false)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TArray< uint8 > const &Content, TMap< FString, FString > &Headers, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TMap< FString, FString > const &Data, TMap< FString, FString > &Headers, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequest (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, FString const &Json, TMap< FString, FString > &Headers, U const &OnSuccess, V const &OnError)
 API request with credentials access token (if available).
template<typename U, typename V>
FAccelByteTaskPtr ApiRequestWithJsonObject (FString const &Verb, FString const &Url, FHttpFormData const &QueryParams, TSharedPtr< FJsonObject > JsonObject, TMap< FString, FString > &Headers, U const &OnSuccess, V const &OnError, bool bOmitBlankValues=false)
 API request with credentials access token (if available).

Detailed Description

HTTP client for building API.

Member Function Documentation

◆ ApiRequest() [1/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
FString const & Json,
TMap< FString, FString > & Headers,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
JsonHTTP request content JSON string (implies Content-Type application/json header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [2/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
FString const & Json,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
JsonHTTP request content JSON string (implies Content-Type application/json header).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [3/11]

template<typename T, typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
T const & UStruct,
TMap< FString, FString > & Headers,
U const & OnSuccess,
V const & OnError,
bool bOmitBlankValues = false )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
UStructHTTP request content from a given UStruct (implies Content-Type application/json header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
bOmitBlankValuesFlag that will remove blank string values from the JSON string sent to the server. Defaults to false.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [4/11]

template<typename T, typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
T const & UStruct,
U const & OnSuccess,
V const & OnError,
bool bOmitBlankValues = false )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
UStructHTTP request content from a given UStruct (implies Content-Type application/json header).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
bOmitBlankValuesFlag that will remove blank string values from the JSON string sent to the server. Defaults to false.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [5/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TArray< uint8 > const & Content,
TMap< FString, FString > & Headers,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
ContentHTTP request content byte array (implies Content-Type application/octet-stream header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [6/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TMap< FString, FString > const & Data,
TMap< FString, FString > & Headers,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
DataHTTP request content form key-value (implies Content-Type application/x-www-form-urlencoded header).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [7/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TMap< FString, FString > const & Data,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
DataHTTP request content form key-value (implies Content-Type application/x-www-form-urlencoded header).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [8/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TSharedPtr< FJsonObject > const & JsonObject,
U const & OnSuccess,
V const & OnError,
bool bOmitBlankValues = false )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
JsonObjectHTTP request content as JSON object.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
bOmitBlankValuesFlag that will remove blank string values from the JSON string sent to the server. Defaults to false.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [9/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TSharedRef< FJsonObject > const & Json,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
JsonHTTP request content JSON Object.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [10/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequest() [11/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequest ( FString const & Verb,
FString const & Url,
U const & OnSuccess,
V const & OnError )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ ApiRequestWithJsonObject()

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::ApiRequestWithJsonObject ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TSharedPtr< FJsonObject > JsonObject,
TMap< FString, FString > & Headers,
U const & OnSuccess,
V const & OnError,
bool bOmitBlankValues = false )
inline

API request with credentials access token (if available).

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
JsonObjectHTTP request content as JSON Object.
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [1/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
FString const & Content,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
ContentHTTP request content string
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [2/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TArray< uint8 > const & Content,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
ContentHTTP request content binary (implies Content-Type application/octet-stream header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [3/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TMap< FString, FString > const & Content,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
ContentHTTP request content form key-value (implies Content-Type application/x-www-form-urlencoded header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [4/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [5/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
TSharedPtr< FJsonObject > JsonObject,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError,
bool bOmitBlankValues = false )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request based on JSON object.
JsonObjectHTTP request content as JSON Object.
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [6/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FHttpFormData const & QueryParams,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
QueryParamsHTTP request query string key-value.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [7/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FString const & Content,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
ContentHTTP request content string
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [8/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
FString const & Content,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
ContentHTTP request content string
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [9/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
TArray< uint8 > const & Content,
TMap< FString, FString > const & Headers,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
ContentHTTP request content binary (implies Content-Type application/octet-stream header).
HeadersHTTP request headers key-value (overrides implicit headers).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [10/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
TArray< uint8 > const & Content,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
ContentHTTP request content binary (implies Content-Type application/octet-stream header).
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.

◆ Request() [11/11]

template<typename U, typename V>
FAccelByteTaskPtr AccelByte::FHttpClient::Request ( FString const & Verb,
FString const & Url,
U const & OnSuccess,
V const & OnError )
inline

Basic HTTP request.

Parameters
VerbHTTP request methods, e.g. GET, POST, PUT, PATCH, DELETE.
UrlHTTP request URL.
OnSuccessCallback when HTTP call is successful.
OnErrorCallback when HTTP call is error.
Returns
FAccelByteTaskPtr.