Lobby - Find Lobbies

FindLobbiesResult

ApiErrorWrapper

This is the outer wrapper for all responses with errors

integer

Numerical HTTP code

string

Playfab error code

integer

Numerical PlayFab error code

object

Detailed description of individual issues with the request object

string

Description for the PlayFab errorCode

string

String HTTP code

string

Unique ID of the entity.

string

Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

string

OData style string that contains one or more filters. Only the following operators are supported: "and" (logical and), "eq" (equal), "ne" (not equals), "ge" (greater than or equal), "gt" (greater than), "le" (less than or equal), and "lt" (less than). The left-hand side of each OData logical expression should be either a search property key (e.g. string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by "lobby/": lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby), lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal 'Unlocked' or 'Locked'), lobby/amOwner (required to equal "true"), lobby/amMember (required to equal "true").

string

OData style string that contains sorting for this query in either ascending ("asc") or descending ("desc") order. OrderBy clauses are of the form "number_key1 asc" or the pre-defined search key "lobby/memberCount asc", "lobby/memberCountRemaining desc" and "lobby/maxMemberCount desc". To sort by closest, a moniker distance{number_key1 = 5} can be used to sort by distance from the given number. This field only supports either one sort clause or one distance clause.

PaginationRequest

Request pagination information.

LobbySummary[]

Array of lobbies found that matched FindLobbies request.

PaginationResponse

Pagination response for FindLobbies request.

string

A string used to join the lobby.This field is populated by the Lobby service.Invites are performed by communicating this connectionString to other players.

number

The current number of players in the lobby.

string

Id to uniquely identify a lobby.

number

The maximum number of players allowed in the lobby.

MembershipLock

A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining.

EntityKey

The client or server entity which owns this lobby.

object

Search data.

string

string

string

Continuation token returned as a result in a previous FindLobbies call. Cannot be specified by clients.

number

The number of lobbies that should be retrieved. Cannot be specified by servers, clients may specify any value up to 50

string

Continuation token returned by server call. Not returned for clients

number

The number of lobbies that matched the search request.