Interface IMultiplayProvidersAdminApi
Represents a collection of functions to interact with the API endpoints
Namespace: Unity.Services.Apis.Admin.Multiplay
Assembly: Unity.Services.Apis.dll
Syntax
public interface IMultiplayProvidersAdminApi : IApiAccessor
Methods
CreateProvider(string, string, MultiplayProviderCreateRequestV1, CancellationToken)
Create a new provider
Declaration
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 |
Multiplay |
multiplayProviderCreateRequestV1 | Contains the properties for the provider. (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
DeleteProvider(string, string, string, CancellationToken)
Delete a provider
Declaration
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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |
ListProviders(string, string, CancellationToken)
List of providers
Declaration
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 |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |