Class ConfigManagerImpl

Inheritance

Object

ConfigManagerImpl

Namespace: Unity.RemoteConfig

Syntax

public class ConfigManagerImpl

Constructors

ConfigManagerImpl(String, String, String, String)

Constructor for the ConfigManagerImpl.

Declaration

public ConfigManagerImpl(string originService, string attributionMetadataStr = "", string cacheFileRC = "RemoteConfig.json", string cacheHeadersFileRC = "RemoteConfigHeaders.json")

Parameters

Type	Name	Description
String	originService	Represents the origin for request, e.g 'GameSim'
String	attributionMetadataStr	An attributtion string to ascribe metadata
String	cacheFileRC	remote config cache file
String	cacheHeadersFileRC	remote config headers cache file

Properties

appConfig

Retrieves the RuntimeConfig object for handling Remote Config settings.

Declaration

public RuntimeConfig appConfig { get; }

Property Value

Type	Description
RuntimeConfig	A class representing a single runtime settings configuration.

Remarks

Use this property to access the following RuntimeConfig methods and classes:

public string assignmentID is a unique string identifier used for reporting and analytic purposes. The Remote Config service generate this ID upon configuration requests.

public bool GetBool (string key, bool defaultValue) retrieves the boolean value of a corresponding key from the remote service, if one exists.

public float GetFloat (string key, float defaultValue) retrieves the float value of a corresponding key from the remote service, if one exists.

public long GetLong (string key, long defaultValue) retrieves the long value of a corresponding key from the remote service, if one exists.

public int GetInt (string key, int defaultValue) retrieves the integer value of a corresponding key from the remote service, if one exists.

public string GetString (string key, string defaultValue) retrieves the string value of a corresponding key from the remote service, if one exists.

public bool HasKey (string key) checks if a corresponding key exists in your remote settings.

public string[] GetKeys () returns all keys in your remote settings, as an array.

public string[] GetJson () returns string representation of the JSON value of a corresponding key from the remote service, if one exists.

requestStatus

Returns the status of the current configuration request from the service.

Declaration

public ConfigRequestStatus requestStatus { get; }

Property Value

Type	Description
ConfigRequestStatus	An enum representing the status of the current Remote Config request.

Methods

FetchConfigs(Object, Object)

Fetches an app configuration settings from the remote server.

Declaration

public void FetchConfigs(object userAttributes, object appAttributes)

Parameters

Type	Name	Description
Object	userAttributes	A struct containing custom user attributes. If none apply, use null.
Object	appAttributes	A struct containing custom app attributes. If none apply, use null.

FetchConfigs<T, T2>(T, T2)

Fetches an app configuration settings from the remote server.

Declaration

public void FetchConfigs<T, T2>(T userAttributes, T2 appAttributes)
    where T : struct where T2 : struct

Parameters

Type	Name	Description
T	userAttributes	A struct containing custom user attributes. If none apply, use an empty struct.
T2	appAttributes	A struct containing custom app attributes. If none apply, use an empty struct.

Type Parameters

Name	Description
T	The type of the userAttributes struct.
T2	The type of the appAttributes struct.

LoadFromCache()

Tries to read from cache files (config and headers) and invokes RawResponseReturned action with cached parameters

Declaration

public void LoadFromCache()

SaveCache(ConfigOrigin, Dictionary<String, String>, String)

Tries to create cache files (config and headers) and write into them if they are successfully fetched from remote location

Declaration

public void SaveCache(ConfigOrigin origin, Dictionary<string, string> headers, string result)

Parameters

Type	Name	Description
ConfigOrigin	origin	represents config origin. If value is Remote, overwrite the file content
Dictionary<String, String>	headers	request headers as a key-value dictionary
String	result	config value

SetCustomUserID(String)

Sets a custom user identifier for the Remote Config delivery request payload.

Declaration

public void SetCustomUserID(string customUserID)

Parameters

Type	Name	Description
String	customUserID	Custom user identifier.

SetEnvironmentID(String)

Sets an environment identifier in the Remote Config delivery request payload.

Declaration

public void SetEnvironmentID(string environmentID)

Parameters

Type	Name	Description
String	environmentID	Environment unique identifier.

Events

FetchCompleted

This event fires when the configuration manager successfully fetches settings from the service.

Declaration

public event Action<ConfigResponse> FetchCompleted

Event Type

Type	Description
Action<ConfigResponse>	A struct representing the response of a Remote Config fetch.