Class CloudRooms
Helps manage rooms in your Project hosted on the coherence Cloud. If you wish to create, delete or fetch rooms in a self-hosted Replication Server, you can instantiate a ReplicationServerRoomsService instead.
public class CloudRooms
- Inheritance
-
CloudRooms
- Extension Methods
Constructors
CloudRooms(CloudCredentialsPair, IRuntimeSettings)
public CloudRooms(CloudCredentialsPair credentialsPair = null, IRuntimeSettings runtimeSettings = null)
Parameters
credentialsPair
CloudCredentialsPairruntimeSettings
IRuntimeSettings
Properties
IsConnectedToCloud
Returns true when the Web Socket is connected.
public bool IsConnectedToCloud { get; }
Property Value
IsLoggedIn
Returns true when the Web Socket is connected and when we are logged in to coherence Cloud.
public bool IsLoggedIn { get; }
Property Value
LobbyService
Get the LobbyService instance to interface with Lobbies in the coherence Cloud.
public LobbiesService LobbyService { get; }
Property Value
Regions
Get the current cached regions that were fetched via the RefreshRegions method.
public IReadOnlyList<string> Regions { get; }
Property Value
Methods
Dispose()
public void Dispose()
GetRoomServiceForRegion(string)
Get an instance of CloudRoomsService for a given region from the CloudRoomsService dictionary.
public CloudRoomsService GetRoomServiceForRegion(string region)
Parameters
region
stringregion of the CloudRoomsService that you want the service of.
Returns
- CloudRoomsService
Returns an instance of CloudRoomsService for a given region.
RefreshRegions(Action<RequestResponse<IReadOnlyList<string>>>)
Get all the available regions for Rooms. You can enable or disable regions in your coherence Dashboard, in the Rooms section.
public void RefreshRegions(Action<RequestResponse<IReadOnlyList<string>>> callback)
Parameters
callback
Action<RequestResponse<IReadOnlyList<string>>>Callback that will be called when regions have been fetched, it includes the list of regions.
RefreshRegionsAsync()
Get all the available regions for Rooms asynchronously. You can enable or disable regions in your coherence Dashboard, in the Rooms section.
public Task<IReadOnlyList<string>> RefreshRegionsAsync()