docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class MultiplayFleetsApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    MultiplayFleetsApi
    Implements
    IMultiplayFleetsApi
    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.Multiplay
    Assembly: Unity.Services.Apis.dll
    Syntax
    public class MultiplayFleetsApi : IMultiplayFleetsApi, IApiAccessor

    Constructors

    MultiplayFleetsApi(IApiClient)

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

    Declaration
    public MultiplayFleetsApi(IApiClient apiClient)
    Parameters
    Type Name Description
    IApiClient apiClient

    The client interface for synchronous API access.

    MultiplayFleetsApi(IApiClient, IApiConfiguration)

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

    Declaration
    public MultiplayFleetsApi(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

    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

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<List<FleetRegion>>

    The operation

    Implements

    IMultiplayFleetsApi
    IApiAccessor
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)