rustore / RuStore Unreal Engine RemoteConfig
CI/CD
Реестр контейнеров и пакетов

API/Autodoc/Classes/URuStoreRemoteConfigClient.en.md

URuStoreRemoteConfigClient

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

#include <URuStoreRemoteConfigClient.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

Name
bool GetIsInitialized()
Checks whether the manager has been initialized.
bool Init()
Initializes the URuStoreRemoteConfigClient singleton.
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 the data configuration according to the update policy selected during initialization.
void GetRemoteConfig(int64 & requestId)
long GetShortSegments(TFunction< void(long, FString)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Retrieves short segments of the data configuration.
void GetShortSegments(int64 & requestId)
URuStoreRemoteConfigClient * Instance()
Gets an instance of URuStoreRemoteConfigClient.

Public Attributes

Name
const FString PluginVersion — Plugin version.
FRuStoreGetRemoteConfigResponseDelegate OnRemoteConfigResponse
FRuStoreGetRemoteConfigErrorDelegate OnRemoteConfigError
FRuStoreGetShortSegmentsResponseDelegate OnShortSegmentsResponse
FRuStoreGetShortSegmentsErrorDelegate OnShortSegmentsError

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()

Checks whether the manager has been initialized.

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

function Init

bool Init()

Initializes the URuStoreRemoteConfigClient singleton.

Return: Returns true if 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 the data configuration according to the update policy selected during initialization.

Parameters:

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

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

function GetRemoteConfig

void GetRemoteConfig(
    int64 & requestId
)

function GetShortSegments

long GetShortSegments(
    TFunction< void(long, FString)> onSuccess,
    TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure
)

Retrieves short segments of the data configuration.

Parameters:

  • onSuccess Action performed on successful completion of the operation. Returns a requestId of type long and an FString containing short configuration segments.
  • onFailure Action performed in case of an error. Returns a requestId of type long and a FURuStoreError object with error information.

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

function GetShortSegments

void GetShortSegments(
    int64 & requestId
)

function Instance

static URuStoreRemoteConfigClient * Instance()

Gets an 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.1";

Plugin version.

variable OnRemoteConfigResponse

FRuStoreGetRemoteConfigResponseDelegate OnRemoteConfigResponse;

variable OnRemoteConfigError

FRuStoreGetRemoteConfigErrorDelegate OnRemoteConfigError;

variable OnShortSegmentsResponse

FRuStoreGetShortSegmentsResponseDelegate OnShortSegmentsResponse;

variable OnShortSegmentsError

FRuStoreGetShortSegmentsErrorDelegate OnShortSegmentsError;
Назад