Class ConfigsAdminApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Admin.RemoteConfig
Assembly: Unity.Services.Apis.dll
Syntax
public class ConfigsAdminApi : IConfigsAdminApi, IApiAccessor
Constructors
ConfigsAdminApi(IApiClient)
Initializes a new instance of the Configs
Declaration
public ConfigsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
ConfigsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Configs
Declaration
public ConfigsAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
IApi |
apiConfiguration | The configuration object. |
Properties
Client
The client for accessing this underlying API asynchronously.
Declaration
public IApiClient Client { get; }
Property Value
Type | Description |
---|---|
IApi |
Configuration
Gets the configuration object
Declaration
public IApiConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
IApi |
An instance of the Configuration |
Methods
CopyConfigByProjectId(string, ConfigCopyRequest, CancellationToken)
Copy Config Settings Copies specified settings from a source Config to a destination Config
Declaration
public ApiOperation CopyConfigByProjectId(string projectId, ConfigCopyRequest configCopyRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | Unity Project Id |
Config |
configCopyRequest | IDs for source and destination Config, and Settings keys to be copied |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateConfig(string, CreateConfigRequest, CancellationToken)
Create Config Create Config.
Declaration
public ApiOperation<CreateConfigResponse> CreateConfig(string projectId, CreateConfigRequest createConfigRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | Unity Project Id |
Create |
createConfigRequest | Config object |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteConfigById(string, string, CancellationToken)
Delete Config Deletes an existing Config
Declaration
public ApiOperation DeleteConfigById(string configId, string projectId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | configId | Configuration Id |
string | projectId | Unity Project Id |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetConfigByEnvironmentId(string, string, CancellationToken)
Get Configs by Environment ID Returns the list of all configs for a Environment. Currently, the only supported config type is "settings"
Declaration
public ApiOperation<GetConfigWithDefaultEnvironment200Response> GetConfigByEnvironmentId(string projectId, string environmentId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | Unity Project Id |
string | environmentId | Environment Id |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetConfigById(string, string, CancellationToken)
Get Config Returns Config for a given ID
Declaration
public ApiOperation<Config> GetConfigById(string configId, string projectId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | configId | Configuration Id |
string | projectId | Unity Project Id |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetConfigWithDefaultEnvironment(string, CancellationToken)
Get config with the default environment Obtain the configs with the default environment 'production' or specified environment id
Declaration
public ApiOperation<GetConfigWithDefaultEnvironment200Response> GetConfigWithDefaultEnvironment(string projectId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | Unity Project Id |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
UpdateConfigById(string, string, UpdateConfigByIdRequest, CancellationToken)
Update Config Updates the value of an existing Config
Declaration
public ApiOperation UpdateConfigById(string configId, string projectId, UpdateConfigByIdRequest updateConfigByIdRequest, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | configId | Configuration Id |
string | projectId | Unity Project Id |
Update |
updateConfigByIdRequest | Updated Config values |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |