Class RuntimeConfig
This class represents a single runtime settings configuration. Access its methods and properties via the ConfigManager.appConfig wrapper.
Inheritance
Namespace: Unity.RemoteConfig
Syntax
public class RuntimeConfigProperties
assignmentID
The Remote Config service generates this unique ID on configuration requests, for reporting and analytic purposes.
Declaration
public string assignmentID { get; }Property Value
| Type | Description |
|---|---|
| System.String | A unique string. |
origin
Retrieves the origin point from which your configuration settings loaded.
Declaration
public ConfigOrigin origin { get; }Property Value
| Type | Description |
|---|---|
| ConfigOrigin | An enum describing the origin point of your most recently loaded configuration settings. |
Methods
GetBool(String, Boolean)
Retrieves the boolean value of a corresponding key, if one exists.
Declaration
public bool GetBool(string key, bool defaultValue = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key identifying the corresponding setting. |
| System.Boolean | defaultValue | The default value to use if the specified key cannot be found or is unavailable. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetFloat(String, Single)
Retrieves the float value of a corresponding key from the remote service, if one exists.
Declaration
public float GetFloat(string key, float defaultValue = 0F)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key identifying the corresponding setting. |
| System.Single | defaultValue | The default value to use if the specified key cannot be found or is unavailable. |
Returns
| Type | Description |
|---|---|
| System.Single |
GetInt(String, Int32)
Retrieves the int value of a corresponding key, if one exists.
Declaration
public int GetInt(string key, int defaultValue = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key identifying the corresponding setting. |
| System.Int32 | defaultValue | The default value to use if the specified key cannot be found or is unavailable. |
Returns
| Type | Description |
|---|---|
| System.Int32 |
GetKeys()
Returns all keys in your remote settings, as an array.
Declaration
public string[] GetKeys()Returns
| Type | Description |
|---|---|
| System.String[] |
GetLong(String, Int64)
Retrieves the long value of a corresponding key from the remote service, if one exists.
Declaration
public long GetLong(string key, long defaultValue = 0L)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key identifying the corresponding setting. |
| System.Int64 | defaultValue | The default value to use if the specified key cannot be found or is unavailable. |
Returns
| Type | Description |
|---|---|
| System.Int64 |
GetString(String, String)
Retrieves the string value of a corresponding key from the remote service, if one exists.
Declaration
public string GetString(string key, string defaultValue = "")Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key identifying the corresponding setting. |
| System.String | defaultValue | The default value to use if the specified key cannot be found or is unavailable. |
Returns
| Type | Description |
|---|---|
| System.String |
HasKey(String)
Checks if a corresponding key exists in your remote settings.
Declaration
public bool HasKey(string key)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key to search for. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|