API/Autodoc/Classes/URuStoreRemoteConfigClient.en.md

---

URuStoreRemoteConfigClient

The class implements an API for retrieving data configuration from a remote server. It encapsulates configuration request from the server, caching, and background update.

#include <URuStoreRemoteConfigClient.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

	Name
bool	GetIsInitialized() Check whether the manager is initialized.
bool	Init() Initializes the singleton URuStoreRemoteConfigClient.
void	Dispose() Deinitializes the singleton if no further work with the object is planned.
void	ConditionalBeginDestroy()
long	GetRemoteConfig(TFunction< void(long, TSharedPtr< FURuStoreRemoteConfig, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure) Retrieves data configuration based on the update policy selected during initialization.
void	GetRemoteConfig(int64 & requestId)
URuStoreRemoteConfigClient *	Instance() Gets the instance of URuStoreRemoteConfigClient.

Public Attributes

	Name
const FString	PluginVersion — Plugin version.
FRuStoreGetRemoteConfigResponseDelegate	OnRemoteConfigResponse
FRuStoreGetRemoteConfigErrorDelegate	OnRemoteConfigError

Additional inherited members

Public Functions inherited from RuStoreSDK::RuStoreListenerContainer

	Name
TSharedPtr< RuStoreListener, ESPMode::ThreadSafe >	ListenerBind(RuStoreListener * item)
void	ListenerUnbind(long id)
void	ListenerUnbind(RuStoreListener * item)
void	ListenerUnbind(TSharedPtr< RuStoreListener, ESPMode::ThreadSafe > item)
void	ListenerRemoveAll()

function GetIsInitialized

bool GetIsInitialized()

Check whether the manager is initialized.

Return: Returns true if the singleton is initialized, otherwise false.

function Init

bool Init()

Initializes the singleton URuStoreRemoteConfigClient.

Return: Returns true if the initialization was successful, otherwise false.

function Dispose

void Dispose()

Deinitializes the singleton if no further work with the object is planned.

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function GetRemoteConfig

long GetRemoteConfig(
    TFunction< void(long, TSharedPtr< FURuStoreRemoteConfig, ESPMode::ThreadSafe >)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Retrieves data configuration based on the update policy selected during initialization.

Parameters:

• onSuccess Action to perform on successful completion of the operation. Returns a requestId of type long and an FURuStoreRemoteConfig object with information about the current data set.
• onFailure Action to perform in case of an error. Returns a requestId of type long and an FURuStoreError object with error information.

Return: Returns a requestId unique within a single application run.

function GetRemoteConfig

void GetRemoteConfig(
    int64 & requestId
)

function Instance

static URuStoreRemoteConfigClient * Instance()

Gets the instance of URuStoreRemoteConfigClient.

Return: Returns a pointer to the single instance of URuStoreRemoteConfigClient (Singleton pattern implementation). If the instance does not exist yet, it creates it.

variable PluginVersion

static const FString PluginVersion = "10.5.0";

Plugin version.

variable OnRemoteConfigResponse

FRuStoreGetRemoteConfigResponseDelegate OnRemoteConfigResponse;

variable OnRemoteConfigError

FRuStoreGetRemoteConfigErrorDelegate OnRemoteConfigError;

---