rustore / Unity RuStore Remote Config SDK
CI/CD
Реестр контейнеров и пакетов

API/Autodoc/Classes/RuStore.RemoteConfig.RuStoreRemoteConfigClient.md

RuStore::RemoteConfig::RuStoreRemoteConfigClient

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

Public Functions

Name
bool Init(RuStoreRemoteConfigClientSettings settings, IRemoteConfigClientEventListener eventListener =null)
Выполняет инициализацию синглтона RuStoreRemoteConfigClient. Для работы в режиме UpdateBehaviour.Actual инициализация может быть выполнена без создания расширения класса Application. При этом параметр APP_ID должен быть передан из C#.
bool Init(IRemoteConfigClientEventListener eventListener =null)
Выполняет инициализацию синглтона RuStoreRemoteConfigClient. Инициализация Java-класса RuStoreUnityRemoteConfigClient с параметрами UpdateBehaviour.Default/UpdateBehaviour.Snapshot должна происходить в момент Application.onCreate(), т.к. при запуске фоновой синхронизации SDK должна быть проинициализирована.
void GetRemoteConfig(Action< RuStoreError > onFailure, Action< RemoteConfig > onSuccess)
Получение конфигурации данных в зависимости от выбранной политики обновления при инициализации.
void SetAccount(string account)
Устанавливает параметр Account, который может быть использован для получения заданной конфигурации.
void SetLanguage(string language)
Устанавливает параметр Language, который может быть использован для получения заданной конфигурации.

Public Properties

Name
bool IsInitialized — Возвращает true, если синглтон инициализирован, в противном случае — false.
RuStoreRemoteConfigClient Instance — Возвращает единственный экземпляр RuStoreRemoteConfigClient (реализация паттерна Singleton). Если экземпляр еще не создан, создает его.

Public Attributes

Name
string PluginVersion — Версия плагина.

function Init

bool Init(
    RuStoreRemoteConfigClientSettings settings,
    IRemoteConfigClientEventListener eventListener =null
)

Выполняет инициализацию синглтона RuStoreRemoteConfigClient. Для работы в режиме UpdateBehaviour.Actual инициализация может быть выполнена без создания расширения класса Application. При этом параметр APP_ID должен быть передан из C#.

Parameters:

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


bool isInitialized = RuStoreRemoteConfigClient.Instance.Init(
    settings: new RuStoreRemoteConfigClientSettings() {
        appId = "app123",
        account = "user123",
        language = "ru"
    },
    eventListener: new MyRemoteConfigEventListener()
);

Filename: public_bool_Init_with_settings.cs

function Init

bool Init(
    IRemoteConfigClientEventListener eventListener =null
)

Выполняет инициализацию синглтона RuStoreRemoteConfigClient. Инициализация Java-класса RuStoreUnityRemoteConfigClient с параметрами UpdateBehaviour.Default/UpdateBehaviour.Snapshot должна происходить в момент Application.onCreate(), т.к. при запуске фоновой синхронизации SDK должна быть проинициализирована.

Parameters:

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


bool isInitialized = RuStoreRemoteConfigClient.Instance.Init(
    eventListener: null
);

Filename: public_bool_Init.cs

function GetRemoteConfig

void GetRemoteConfig(
    Action< RuStoreError > onFailure,
    Action< RemoteConfig > onSuccess
)

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

Parameters:

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

RuStoreRemoteConfigClient.Instance.GetRemoteConfig(
    onFailure: (error) => {
        // Process error
    },
    onSuccess: (config) => {
        // Process config
    }
);

Filename: public_void_GetRemoteConfig.cs

function SetAccount

void SetAccount(
    string account
)

Устанавливает параметр Account, который может быть использован для получения заданной конфигурации.

Parameters:

  • account Значение параметра Account.

RuStoreRemoteConfigClient.Instance.SetAccount(account: "user123");

Filename: public_void_SetAccount.cs

function SetLanguage

void SetLanguage(
    string language
)

Устанавливает параметр Language, который может быть использован для получения заданной конфигурации.

Parameters:

  • language Значение параметра Language.

RuStoreRemoteConfigClient.Instance.SetLanguage("en");

Filename: public_void_SetLanguage.cs

property IsInitialized

bool IsInitialized;

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

property Instance

static RuStoreRemoteConfigClient Instance;

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


var client = RuStoreRemoteConfigClient.Instance;

Filename: public_static_RuStoreRemoteConfigClient_Instance.cs

variable PluginVersion

static string PluginVersion = "10.3.1";

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

Назад