Namespace Unity.Services.Lobbies.Models

Classes

CreateRequest

The body of a Create Lobby request.

DataObject

Custom data property for a lobby.

Detail

Additional detail about an error. This may include detailed validation failure messages, debugging information, troubleshooting steps, or more.

ErrorStatus

The body that will be returned for any failing request. We are using the RFC 7807 Error Format.

JoinByCodeRequest

The body of a Join Lobby request using lobby code.

JoinByIdRequest

The body of a Join request

Lobby

Data about an individual lobby.

Player

Information about a specific player creating, joining, or already in a lobby.

PlayerDataObject

Custom data property for a player.

PlayerProfile

A player's profile data from the Social Profile service.

PlayerUpdateRequest

The body of an Update Player Data request.

QueryFilter

A filter for an individual field that is applied to a query.

QueryOrder

An order for an individual field that is applied to a query.

QueryRequest

The body of a Query request which defines how to sort and filter results, how many results to return, etc.

QueryResponse

A list of lobbies that matched the specified query. Only the public top-level data and player data properties are returned.

QuickJoinRequest

The body of a QuickJoin request.

TokenData

The data associated with the token.

TokenRequest

Details about a token being requested.

UpdateRequest

The body of an Update Lobby request.

Interfaces

IOneOf

Interface to a result that could be one of many possible types.

Enums

DataObject.IndexOptions

The name of the column to index this property value under, either S# for strings or N# for numeric values. If an index is specified on a property, then you can use that index name in a QueryFilter to filter results by that property. You will not be prevented from indexing multiple objects having properties with different names but the same index, but you will likely receive unexpected results from a query.

DataObject.VisibilityOptions

Indicates for whom the property should be visible. If public, the property will be visible to everyone and will be included in query results. If member, the data will only be visible to users who are members of the lobby (i.e. those who have successfully joined). If private, the metadata will only be visible to the host.

PlayerDataObject.VisibilityOptions

Indicates for whom the property should be visible. If public, the property will be visible to everyone and will be included in query results. If member, the data will only be visible to users who are members of the lobby (i.e. those who have successfully joined). If private, the metadata will only be visible to the player.

QueryFilter.FieldOptions

The name of the field to filter on. For custom data fields, the name of the index must be used instead of the field name.

QueryFilter.OpOptions

The operator used to compare the field to the filter value. Supports CONTAINS (only on the Name field), EQ (Equal), NE (Not Equal), LT (Less Than), LE (Less Than or Equal), GT (Greater Than), and GE (Greater Than or Equal).

QueryOrder.FieldOptions

The name of the field to order on.

TokenRequest.TokenTypeOptions

Defines TokenType