Table of Contents

Coherence.Cloud

Classes

AuthClient

Specifies a set of methods that can be used to log in to coherence Cloud, properties to determine if we are currently logged in or not, and events for getting notified about relevant things happening.

CloudCredentialsPair
CloudOperation

Represents an asynchronous operation used to communicate with coherence Cloud.

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.

CloudRoomsService

Public API to interface with Rooms from your Project in the coherence Cloud. If you wish to create, delete or fetch rooms in a self-hosted Replication Server, you can instantiate a ReplicationServerRoomsService instead.

CloudService

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.

CloudStorage

CloudStorage is a service that allows you to save and load objects (Coherence.Cloud.StorageObject) to and from the backend.

CoherenceCloud

Provides multiple ways to authenticate players with the coherence Cloud, giving them access to its services.

CoherenceTask

Represents an asynchronous operation.

CommandLineArguments
CreateLobbyOptions
FindLobbyOptions
GameServersService
GameServices
HttpServer
Identity

Represents a single identity linked to a player account.

KvStoreClient

The old cloud-backed key-value store service. Superseded by CloudStorage. To use this service, you must have 'Player Key-Value Store' enabled in Project Settings in your coherence Dashboard.

LobbiesService
LobbyOwnerSession
LobbySession
LoginError

Represents an AuthClient error that has occurred either during an attempted login operation, or after a successful login operation, when the client's connection to coherence Cloud has been forcefully closed by the server (Coherence.Runtime.ErrorType.ConcurrentConnection).

LoginOperation

Represents an asynchronous operation attempting to login to coherence Cloud.

LoginOperationError

Represents an error that occurred when attempting to log in to coherence Cloud.

If the LoginOperation.Error is never observed by the user, it will get automatically logged to the Console.

LoginResult

Represents the result of an IAuthClient login operation.

MatchMakerException
MatchmakerClient
PlayerAccount

Represents a player account that has logged in to coherence Cloud.

PlayerAccountInfo

Contains all data associated with a PlayerAccount from coherence Cloud.

PlayerAccountOperation

Represents an asynchronous cloud operation related to a PlayerAccount that has logged in to coherence Cloud.

PlayerAccountOperationError

Represents an error that has occurred when attempting to perform operations related to a PlayerAccount.

ReplicationServerRoomsService

Public API to interface with Rooms from a self-hosted Replication Server. If you wish to create, delete or fetch rooms in the coherence Cloud, you can instantiate a CloudService instead to access the CloudRooms API.

ReplicationServerUtils
RequestFactory
ResponseDeserializationException
RoomCreationOptions
RoomRegionsService
RoomsCache
SecretsCache
SelfHostedRoomCreationOptions
StorageError

Represents an error that occurred when interacting with the CloudStorage service.

If the error is never observed by the user, it will get automatically logged to the Console.

StorageOperation

Represents an asynchronous CloudStorage operation.

WorldsResolverException
WorldsService

Structs

CloudAttribute
CloudUniqueId

A locally unique identifier associated with a player account.

The id can be provided by the user via CoherenceBridge's Editor when 'Player Account' is set to 'Login As Guest', or via the LoginAsGuestOptions when calling LoginAsGuest(LoginAsGuestOptions, CancellationToken). If no Cloud Unique Id is provided by the user, then one is generated automatically, and cached locally on the device.

Cloud Unique Ids can be used to create and log into multiple different guest player accounts on the same device. This might be useful for local multiplayer games, allowing each player to log into their own guest player account.

GameServerData
GameServerDeployOptions
GameServerDeployResult
GameServerListOptions
GameServerMatchOptions
GameServerStats
GuestId

Represents a unique identifier for a guest player account that has logged in to coherence Cloud.

HostData
LegacyLoginData

Represents locally cached data for the last player account that was logged in using the old login system.

LobbyData
LobbyFilter
LobbyPlayer

Contains information about a player that has joined a lobby.

LobbyPlayerStats
LobbyPlayersFilteredStats
LobbySortOption
LobbyStats
LocalRoomData
LocalRoomsListItem
LocalRoomsResponse
LoginAsGuestOptions

Specifies options that can be provided when logging in to coherence Cloud as a guest .

MessagesReceived
OptionalGameServerData
PlayerAccountId

A globally unique identifier for a PlayerAccount.

RequestResponse
RoomData
RoomHostData
RoomMatchResponse
SessionToken

A token uniquely identifying a player account that has logged in to coherence Cloud.

StorageObjectId

A unique identifier for an object stored in CloudStorage.

WorldData

Interfaces

IAuthClient

Specifies a set of methods that can be used to log in to coherence Cloud, properties to determine if we are currently logged in or not, and events for getting notified about relevant things happening.

IGameServersService
IRequestFactory
IRoomsService

Enums

FilterGroupOperator
FilterKey
FilterOperator
IdentityType

Specifies the types of identities that can be linked to a player account.

IntAggregator
IntAttributeIndex
LoginErrorType

Specifies the types of errors that can occur when attempting to login.

PlayerAccountErrorType

Specifies the types of errors that can occur when attempting to perform operations related to a PlayerAccount.

RequestStatus
SortOptions
StorageErrorType

Specifies the different types of errors that can occur when interacting with the CloudStorage service.

StringAggregator
StringAttributeIndex

Delegates

OnMainPlayerAccountChangedEventHandler

Reference to a method that should be called when the first login operation to coherence Cloud starts, when the main player account is changed to a different one using SetAsMain(), and when the main player account logs out from coherence cloud.