Class EnvironmentsAdminApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

EnvironmentsAdminApi

Implements

IEnvironmentsAdminApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

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 EnvironmentsAdminApi class using a Configuration object and client instance.

Declaration

public EnvironmentsAdminApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

EnvironmentsAdminApi(IApiClient, IApiConfiguration)

Initializes a new instance of the EnvironmentsAdminApi class using a Configuration object and client instance.

Declaration

public EnvironmentsAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.
IApiConfiguration	apiConfiguration	The configuration object.

Properties

Client

The client for accessing this underlying API asynchronously.

Declaration

public IApiClient Client { get; }

Property Value

Type	Description
IApiClient

Configuration

Gets the configuration object

Declaration

public IApiConfiguration Configuration { get; }

Property Value

Type	Description
IApiConfiguration	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<DefaultEnvironmentResponse>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<Environment>	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<GetEnvironmentsResponse>	The operation

Implements

IEnvironmentsAdminApi

IApiAccessor