Interface IUGCEnvironmentApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.UGC
Assembly: solution.dll
Syntax
public interface IUGCEnvironmentApi : IApiAccessorMethods
GetEnvironment(bool?, CancellationToken)
Get the current user environment
Declaration
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
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
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 |