Class MultiplayFleetsApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public class MultiplayFleetsApi : IMultiplayFleetsApi, IApiAccessor
Constructors
MultiplayFleetsApi(IApiClient)
Initializes a new instance of the Multiplay
Declaration
public MultiplayFleetsApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
MultiplayFleetsApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Multiplay
Declaration
public MultiplayFleetsApi(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 |
ListFleetQoSRegions(string, CancellationToken)
List fleet qos regions List the qos regions for a fleet.
Declaration
public ApiOperation<List<FleetRegion>> ListFleetQoSRegions(string fleetId, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | fleetId | ID of the fleet |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |