Class MultiplayProvidersAdminApi
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 MultiplayProvidersAdminApi : IMultiplayProvidersAdminApi, IApiAccessorConstructors
MultiplayProvidersAdminApi(IApiClient)
Initializes a new instance of the MultiplayProvidersAdminApi class using a Configuration object and client instance.
Declaration
public MultiplayProvidersAdminApi(IApiClient apiClient)Parameters
| Type | Name | Description |
|---|---|---|
| IApiClient | apiClient | The client interface for synchronous API access. |
MultiplayProvidersAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the MultiplayProvidersAdminApi class using a Configuration object and client instance.
Declaration
public MultiplayProvidersAdminApi(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
CreateProvider(string, string, MultiplayProviderCreateRequestV1, CancellationToken)
Create a new provider Creates a new provider for Multiplay, enabling the creation of resources under this provider.
Declaration
public ApiOperation<MultiplayProviderProviderV1> CreateProvider(string projectId, string environmentId, MultiplayProviderCreateRequestV1 multiplayProviderCreateRequestV1 = null, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | The project's Project ID |
| string | environmentId | The Environment ID of a project |
| MultiplayProviderCreateRequestV1 | multiplayProviderCreateRequestV1 | Contains the properties for the provider. (optional) |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| ApiOperation<MultiplayProviderProviderV1> | The operation |
DeleteProvider(string, string, string, CancellationToken)
Delete a provider Delete a provider under a given project.
Declaration
public ApiOperation DeleteProvider(string projectId, string environmentId, string providerId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | The project's Project ID |
| string | environmentId | The Environment ID of a project |
| string | providerId | Provider ID |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| ApiOperation | The operation |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()Returns
| Type | Description |
|---|---|
| string | The base path |
ListProviders(string, string, CancellationToken)
List of providers List the providers enabled for this project.
Declaration
public ApiOperation<MultiplayProviderProviderListV1> ListProviders(string projectId, string environmentId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | projectId | The project's Project ID |
| string | environmentId | The Environment ID of a project |
| CancellationToken | cancellationToken | Cancellation Token to cancel the request. |
Returns
| Type | Description |
|---|---|
| ApiOperation<MultiplayProviderProviderListV1> | The operation |