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

API/Autodoc/Classes/URuStoreRemoteConfigClient.md

URuStoreRemoteConfigClient

Класс реализует API для получения конфигурации данных с удаленного сервера. Инкапсулирует запрос конфигурации с сервера, кэширование, фоновое обновление.

#include <URuStoreRemoteConfigClient.h>

Inherits from UObject, RuStoreSDK::RuStoreListenerContainer

Public Functions

Name
bool GetIsInitialized()
Проверка инициализации менеджера.
bool Init()
Выполняет инициализацию синглтона URuStoreRemoteConfigClient.
void Dispose()
Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.
void ConditionalBeginDestroy()
long GetRemoteConfig(TFunction< void(long, TSharedPtr< FURuStoreRemoteConfig, ESPMode::ThreadSafe >)> onSuccess, TFunction< void(long, TSharedPtr< FURuStoreError, ESPMode::ThreadSafe >)> onFailure)
Получение конфигурации данных в зависимости от выбранной политики обновления при инициализации.
void GetRemoteConfig(int64 & requestId)
URuStoreRemoteConfigClient * Instance()
Получить экземпляр URuStoreRemoteConfigClient.

Public Attributes

Name
const FString PluginVersion — Версия плагина.
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()

Проверка инициализации менеджера.

Return: Возвращает true, если синглтон инициализирован, в противном случае — false.

function Init

bool Init()

Выполняет инициализацию синглтона URuStoreRemoteConfigClient.

Return: Возвращает true, если инициализация была успешно выполнена, в противном случае — false.

function Dispose

void Dispose()

Деинициализация синглтона, если дальнейшая работа с объектом больше не планируется.

function ConditionalBeginDestroy

void ConditionalBeginDestroy()

function GetRemoteConfig

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

Получение конфигурации данных в зависимости от выбранной политики обновления при инициализации.

Parameters:

  • onSuccess Действие, выполняемое при успешном завершении операции. Возвращает requestId типа long и объект FURuStoreRemoteConfig с информцаией о текущем наборе данных.
  • onFailure Действие, выполняемое в случае ошибки. Возвращает requestId типа long и объект типа FURuStoreError с информацией об ошибке.

Return: Возвращает уникальный в рамках одного запуска приложения requestId.

function GetRemoteConfig

void GetRemoteConfig(
    int64 & requestId
)

function Instance

static URuStoreRemoteConfigClient * Instance()

Получить экземпляр URuStoreRemoteConfigClient.

Return: Возвращает указатель на единственный экземпляр URuStoreRemoteConfigClient (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.

variable PluginVersion

static const FString PluginVersion = "10.5.0";

Версия плагина.

variable OnRemoteConfigResponse

FRuStoreGetRemoteConfigResponseDelegate OnRemoteConfigResponse;

variable OnRemoteConfigError

FRuStoreGetRemoteConfigErrorDelegate OnRemoteConfigError;
Назад