Class CloudService

Namespace

Coherence.Cloud

Assembly

Coherence.Runtime.dll

Runtime API to be able to interface with an Organization and Project from the coherence Cloud. Check the coherence Cloud tab in the coherence Hub window for more details.

public class CloudService

Inheritance

object

CloudService

Extension Methods

CloudServiceCoroutineExtensions.WaitForInitialization(CloudService)

Constructors

CloudService(string, bool, IRuntimeSettings)

public CloudService(string uniqueId = null, bool autoLoginAsGuest = true, IRuntimeSettings runtimeSettings = null)

Parameters

uniqueId string

autoLoginAsGuest bool

runtimeSettings IRuntimeSettings

Properties

GameServices

Collection of Game Services that you can interact with in the coherence Dashboard under the Game Services section of your project.

public GameServices GameServices { get; }

Property Value

GameServices

IsReady

Returns true when the Web Socket is connected and when we are logged in to coherence Cloud.

public bool IsReady { get; }

Property Value

bool

Rooms

Rooms REST service to fetch, create and delete rooms in the specified coherence Project from the RuntimeSettings.

public CloudRooms Rooms { get; }

Property Value

CloudRooms

RuntimeSettings

RuntimeSettings that you pass through the constructor, if none is specified, RuntimeSettings.instance will be used.

public IRuntimeSettings RuntimeSettings { get; }

Property Value

IRuntimeSettings

Worlds

Worlds REST service to fetch the available worlds that are online in the specified coherence Project from the RuntimeSettings.

public WorldsService Worlds { get; }

Property Value

WorldsService

Methods

Dispose()

public void Dispose()

WaitForCloudServiceReadyAsync(int)

Async method you can use to wait for the CloudService to be ready.

public Task<bool> WaitForCloudServiceReadyAsync(int millisecondsPollDelay)

Parameters

millisecondsPollDelay int

Returns

Task<bool>

Returns true when the CloudService is ready.

WaitForCloudServiceReadyRoutine()

IEnumerator you can use to wait for the CloudService to be ready within a Coroutine.

public IEnumerator WaitForCloudServiceReadyRoutine()

Returns

IEnumerator