Skip to content

Mirror::Cloud::ListServerService::ListServerClientApi

Inherits from ListServerBaseApi, IListServerClientApi, BaseApi, IBaseApi

Public Functions

Name
ListServerClientApi(ICoroutineRunner runner, IRequestCreator requestCreator, ServerListEvent onServerListUpdated)
void Shutdown()
Cleans up any data created by the instance
void GetServerList()
Get the server list once
void StartGetServerListRepeat(int interval)
Start getting the server list every interval
void StopGetServerListRepeat()
Stop getting the server list

Public Properties

Name
UnityAction< ServerCollectionJson > onServerListUpdated

Additional inherited members

Protected Functions inherited from ListServerBaseApi

Name
ListServerBaseApi(ICoroutineRunner runner, IRequestCreator requestCreator)

Protected Functions inherited from BaseApi

Name
BaseApi(ICoroutineRunner runner, IRequestCreator requestCreator)

Protected Attributes inherited from BaseApi

Name
readonly ICoroutineRunner runner
readonly IRequestCreator requestCreator

Public Functions Documentation

function ListServerClientApi

inline ListServerClientApi(
    ICoroutineRunner runner,
    IRequestCreator requestCreator,
    ServerListEvent onServerListUpdated
)

function Shutdown

inline void Shutdown()

Cleans up any data created by the instance

Reimplements: Mirror::Cloud::IBaseApi::Shutdown

For Example: removing server from list

function GetServerList

inline void GetServerList()

Get the server list once

Reimplements: Mirror::Cloud::ListServerService::IListServerClientApi::GetServerList

function StartGetServerListRepeat

inline void StartGetServerListRepeat(
    int interval
)

Start getting the server list every interval

Parameters:

  • interval

Reimplements: Mirror::Cloud::ListServerService::IListServerClientApi::StartGetServerListRepeat

function StopGetServerListRepeat

inline void StopGetServerListRepeat()

Stop getting the server list

Reimplements: Mirror::Cloud::ListServerService::IListServerClientApi::StopGetServerListRepeat

Public Property Documentation

property onServerListUpdated

UnityAction< ServerCollectionJson > onServerListUpdated;

Updated on 22 January 2021 at 08:52:36 UTC