Class EnvironmentsAdminApi
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 EnvironmentsAdminApi : IEnvironmentsAdminApi, IApiAccessor
Constructors
EnvironmentsAdminApi(IApiClient)
Initializes a new instance of the Environments
Declaration
public EnvironmentsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
EnvironmentsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Environments
Declaration
public EnvironmentsAdminApi(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
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetDefaultEnvironment(string, CancellationToken)
Get Default Environment Obtain the id of the default environment.
Declaration
public ApiOperation<DefaultEnvironmentResponse> GetDefaultEnvironment(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 |
GetEnvironmentById(string, string, CancellationToken)
Get Environment Return environment for a given ID
Declaration
public ApiOperation<Environment> GetEnvironmentById(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 |
GetEnvironmentsByProjectId(string, CancellationToken)
Get All Environments Returns the list of environments for a Project.
Declaration
public ApiOperation<GetEnvironmentsResponse> GetEnvironmentsByProjectId(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 |