Class MultiplayBuildsAdminApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Admin.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public class MultiplayBuildsAdminApi : IMultiplayBuildsAdminApi, IApiAccessor
Constructors
MultiplayBuildsAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayBuildsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayBuildsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayBuildsAdminApi(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
CreateBuild(string, string, MultiplayBuildsBuildCreateReq, CancellationToken)
Create new build This API creates a new build satisfying the requirements in the create request.
Declaration
public ApiOperation<MultiplayBuildsBuild> CreateBuild(string projectId, string environmentId, MultiplayBuildsBuildCreateReq multiplayBuildsBuildCreateReq = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
Multiplay |
multiplayBuildsBuildCreateReq | Contains the properties for the build. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateNewBuildVersion(string, string, long, MultiplayBuildsBuildVersionUpdateReq, CancellationToken)
Create a new build version This API updates the build by creating a new version satisfying the requirements in the create request.
Declaration
public ApiOperation<object> CreateNewBuildVersion(string projectId, string environmentId, long buildId, MultiplayBuildsBuildVersionUpdateReq multiplayBuildsBuildVersionUpdateReq = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
Multiplay |
multiplayBuildsBuildVersionUpdateReq | Contains the properties for the build. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
CreateOrUpdateBuildFile(string, string, long, MultiplayBuildsBuildFileCreateOrUpdateReq, CancellationToken)
Create or update build files for a given build This API creates or updates build files for the build identified by the given build ID.
Declaration
public ApiOperation<MultiplayBuildsBuildFilesListItem> CreateOrUpdateBuildFile(string projectId, string environmentId, long buildId, MultiplayBuildsBuildFileCreateOrUpdateReq multiplayBuildsBuildFileCreateOrUpdateReq = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
Multiplay |
multiplayBuildsBuildFileCreateOrUpdateReq | Contains the properties for the build file. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteBuild(string, string, long, bool?, CancellationToken)
Delete a single build Delete a single build with the given ID.
Declaration
public ApiOperation DeleteBuild(string projectId, string environmentId, long buildId, bool? dryRun = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
bool? | dryRun | Dry run the request. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteBuildFileByPath(string, string, long, string, CancellationToken)
Delete a build file by path for a given build This API deletes a build file by path for the build identified by the given ID.
Declaration
public ApiOperation DeleteBuildFileByPath(string projectId, string environmentId, long buildId, string filePath, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
string | filePath | The path of the file to delete. |
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 |
GetBuild(string, string, long, CancellationToken)
Get a single build This API returns the details of the build identified by the given ID.
Declaration
public ApiOperation<MultiplayBuildsBuild> GetBuild(string projectId, string environmentId, long buildId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetBuildFiles(string, string, long, int?, int?, CancellationToken)
Get a list of build files for a given build This API returns a list of build files for the build identified by the given ID.
Declaration
public ApiOperation<MultiplayBuildsBuildFilesList> GetBuildFiles(string projectId, string environmentId, long buildId, int? limit = null, int? offset = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
int? | limit | Limit (optional) |
int? | offset | Offset (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
GetBuildInstalls(string, string, long, CancellationToken)
Get a list of installs for a single build This API returns a list of installs for the build identified by the given ID.
Declaration
public ApiOperation<List<MultiplayBuildsBuildInstall>> GetBuildInstalls(string projectId, string environmentId, long buildId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListBuilds(string, string, string, string, string, string, string, string, CancellationToken)
Get a list of builds This API returns a list of builds for the given Unity project GUID.
Declaration
public ApiOperation<List<MultiplayBuildsBuilds>> ListBuilds(string projectId, string environmentId, string limit = null, string lastVal = null, string lastId = null, string sortBy = null, string sortDir = null, string partialFilter = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
string | limit | Report type (optional) |
string | lastVal | Pagination details, last value of the sort column on the previous page. (optional) |
string | lastId | Pagination details, last value of the id column on the previous page. (optional) |
string | sortBy | Pagination details, sort column, if empty uses the id column. (optional) |
string | sortDir | Pagination details, sorting order. (optional, default to ASC) |
string | partialFilter | Partial Filter. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
UpdateBuild(string, string, long, MultiplayBuildsBuildUpdateReq, CancellationToken)
Update a single build This API updates the details of the build identified by the given ID.
Declaration
public ApiOperation<MultiplayBuildsBuild> UpdateBuild(string projectId, string environmentId, long buildId, MultiplayBuildsBuildUpdateReq multiplayBuildsBuildUpdateReq = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | The project's Project ID |
string | environmentId | The Environment ID of a project |
long | buildId | Build ID. |
Multiplay |
multiplayBuildsBuildUpdateReq | Contains the updated properties for the build. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |