Interface IServersApi

Provides access to server information for the project. See https://services.docs.unity.com/multiplay-config/v1/#tag/Servers for details

Inherited Members
Namespace: Unity.Services.Multiplay.Authoring.Core.MultiplayApi
Assembly: Unity.Services.Multiplayer.Multiplay.Authoring.Core.dll
Syntax
public interface IServersApi : IInitializable

Methods

GetServerActionLogsAsync(long, CancellationToken)

Lists the Action Logs for a server

Declaration
Task<List<ActionLog>> GetServerActionLogsAsync(long serverId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
long serverId
CancellationToken cancellationToken
Returns
Type Description
Task<List<ActionLog>>

GetServerAsync(long, CancellationToken)

Get the details of a single server with the given ID

Declaration
Task<ServerInfo> GetServerAsync(long serverId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
long serverId
CancellationToken cancellationToken
Returns
Type Description
Task<ServerInfo>

TriggerServerActionAsync(long, ServerAction, CancellationToken)

Trigger an action against the server with the given id

Declaration
Task<bool> TriggerServerActionAsync(long serverId, ServerAction action, CancellationToken cancellationToken = default)
Parameters
Type Name Description
long serverId
ServerAction action
CancellationToken cancellationToken
Returns
Type Description
Task<bool>