Class UGCEnvironmentApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

UGCEnvironmentApi

Implements

IUGCEnvironmentApi

IApiAccessor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.UGC

Assembly: solution.dll

Syntax

public class UGCEnvironmentApi : IUGCEnvironmentApi, IApiAccessor

Constructors

UGCEnvironmentApi(IApiClient)

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

Declaration

public UGCEnvironmentApi(IApiClient apiClient)

Parameters

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

UGCEnvironmentApi(IApiClient, IApiConfiguration)

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

Declaration

public UGCEnvironmentApi(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

GetEnvironment(bool?, CancellationToken)

Get the current user environment

Declaration

public ApiOperation<EnvironmentDTO> GetEnvironment(bool? includeStatistics = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	includeStatistics	If environment stats should be included in the environment (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<EnvironmentDTO>	The operation

GetEnvironments(bool?, CancellationToken)

Get the current users environments based on current project

Declaration

public ApiOperation<List<EnvironmentDTO>> GetEnvironments(bool? includeStatistics = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	includeStatistics	If environment stats should be included in the environment (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<EnvironmentDTO>>	The operation

GetProjectEnvironments(string, bool?, CancellationToken)

Get all the environments for a given project id

Declaration

public ApiOperation<List<EnvironmentDTO>> GetProjectEnvironments(string projectId, bool? includeStatistics = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project id
bool?	includeStatistics	If environment stats should be included in the query (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<EnvironmentDTO>>	The operation

Implements

IUGCEnvironmentApi

IApiAccessor