Interface IMultiplayProvidersAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

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
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

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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation	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
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayProviderProviderListV1>	The operation