Class QosDiscoveryApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

QosDiscoveryApi

Implements

IQosDiscoveryApi

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.QoS

Assembly: Unity.Services.Apis.dll

Syntax

public class QosDiscoveryApi : IQosDiscoveryApi, IApiAccessor

Constructors

QosDiscoveryApi(IApiClient)

Initializes a new instance of the QosDiscoveryApi class using a Configuration object and client instance.

Declaration

public QosDiscoveryApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

QosDiscoveryApi(IApiClient, IApiConfiguration)

Initializes a new instance of the QosDiscoveryApi class using a Configuration object and client instance.

Declaration

public QosDiscoveryApi(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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetServers(List<string>, string, CancellationToken)

Get Servers Query for QoS servers with optional filters. This endpoint returns a list of QoS server connection information that you can use to determine connection quality between a client and a given region. You can filter the response to only include servers in the specified regions or servers used by a specified service. > Note: Region naming is service-specific (for example, the Multiplay has a separate region naming system). A given region in Multiplay might use the same QoS server as a QoS server in Relay, even if the name differs.

Declaration

public ApiOperation<QosServersResponseBody> GetServers(List<string> region = null, string service = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
List<string>	region	(optional)
string	service	The service for which the client is requesting QoS servers. Valid values are: - relay - multiplay (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QosServersResponseBody>	The operation

GetServiceServers(string, List<string>, List<string>, CancellationToken)

Get Service Servers Query for QoS servers for a specific service with optional filters. This endpoint returns a list of QoS server connection information that you can use to determine connection quality between a client and a given server. > Note: Filters and region naming is service-specific. When querying for Multiplay service QoS servers you MUST pass fleet but regions will be ignored. When querying for Relay service QoS servers you MAY pass regions but fleet will be ignored.

Declaration

public ApiOperation<QosServiceServersResponseBody> GetServiceServers(string serviceId, List<string> region = null, List<string> fleet = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	serviceId	The service for which the client is requesting QoS servers. Valid values are: - relay - multiplay
List<string>	region	(optional)
List<string>	fleet	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<QosServiceServersResponseBody>	The operation

Implements

IQosDiscoveryApi

IApiAccessor