Class MultiplayMachinesAdminApi
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 MultiplayMachinesAdminApi : IMultiplayMachinesAdminApi, IApiAccessor
Constructors
MultiplayMachinesAdminApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayMachinesAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayMachinesAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayMachinesAdminApi(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 |
ListMachines(string, string, string, string, string, string, string, string, string, string, string, string, CancellationToken)
List machines List all machines in this project environment.
Declaration
public ApiOperation<List<MultiplayMachinesMachine>> ListMachines(string projectId, string environmentId, string limit = null, string lastId = null, string lastVal = null, string sortBy = null, string sortDir = null, string fleetId = null, string locationId = null, string hardwareType = null, string partial = null, string status = 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 | Results limit (optional) |
string | lastId | Last ID (optional) |
string | lastVal | Last value (optional) |
string | sortBy | Sort column (optional) |
string | sortDir | Sort direction (optional, default to ASC) |
string | fleetId | Fleet ID (optional) |
string | locationId | Location ID (optional) |
string | hardwareType | Hardware Type (optional) |
string | partial | Partial Filter (optional) |
string | status | Status (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |