GetLobbyInstances

Gets a map keyed by rating of the visible lobby instances matching the given type and rating range.

Service	Operation
lobby	GET_LOBBY_INSTANCES

Method Parameters

Parameter	Description
lobbyType	The type of lobby to look for. Lobby types are defined in the portal.
criteriaJson	JSON object describing the filter criteria. Supported sub-values include: 'rating'.

Usage

http://localhost:3000

C#

string lobbyType = "Relay_lobbyT_v2";
Dictionary<string, object> criteriaJson = new Dictionary<string, object>
{
  { "rating", new Dictionary<string, object>
      {
        { "min", 10 },
        { "max", 100 }
      }
  }
};

SuccessCallback successCallback = (response, cbObject) =>
{
    Debug.Log(string.Format("Success | {0}", response));
};
FailureCallback failureCallback = (status, code, error, cbObject) =>
{
    Debug.Log(string.Format("Failed | {0}  {1}  {2}", status, code, error));
};

_bc.LobbyService.GetLobbyInstances(lobbyType, criteriaJson, successCallback, failureCallback);

C++

const char *lobbyType = "Relay_lobbyT_v2";
const char *criteriaJson = "{\"rating\":{\"min\":10,\"max\":100}}";

_bc->getLobbyService()->getLobbyInstances(lobbyType, criteriaJson, this);

Objective-C

NSString *lobbyType = @"Relay_lobbyT_v2";
NSString *criteriaJson = @"{\"rating\":{\"min\":10,\"max\":100}}";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc lobbyService] getLobbyInstances:lobbyType
               criteriaJson:criteriaJson
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String lobbyType = "Relay_lobbyT_v2";
String criteriaJson = "{\"rating\":{\"min\":10,\"max\":100}}";

this; // implements IServerCallback

_bc.getLobbyService().getLobbyInstances(lobbyType, criteriaJson, this);

public void serverCallback(ServiceName serviceName, ServiceOperation serviceOperation, JSONObject jsonData)
{
    System.out.print(String.format("Success | %s", jsonData.toString()));
}
public void serverError(ServiceName serviceName, ServiceOperation serviceOperation, int statusCode, int reasonCode, String jsonError)
{
    System.out.print(String.format("Failed | %d %d %s", statusCode,  reasonCode, jsonError.toString()));
}

JavaScript

var lobbyType = "Relay_lobbyT_v2";
var "criteriaJson" = {
      "rating": {
        "min": 10,
        "max": 100
      }
    };

_bc.lobby.getLobbyInstances(lobbyType, criteriaJson, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  lobbyType = "Relay_lobbyT_v2";
var  "criteriaJson" = {
      "rating": {
        "min": 10,
        "max": 100
      }
    };

ServerResponse result = await _bc.lobbyService.getLobbyInstances(lobbyType:lobbyType, criteriaJson:criteriaJson);

if (result.statusCode == 200) {
    print("Success");
} else {
    print("Failed ${result.error['status_message'] ?? result.error}");
}

Cloud Code

var lobbyType = "Relay_lobbyT_v2";
var criteriaJson = {
      "rating": {
        "min": 10,
        "max": 100
      }
    };
var lobbyProxy = bridge.getLobbyServiceProxy();

var postResult = lobbyProxy.getLobbyInstances(lobbyType, criteriaJson);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "lobby",
    "operation": "GET_LOBBY_INSTANCES",
    "data": {
        "lobbyType": "Relay_lobbyT_v2",
    "criteriaJson": {
      "rating": {
        "min": 10,
        "max": 100
      }
    }
    }
}

tip

If the "settings" parameter is specified during the creation of a lobby, as demonstrated below:

{
    "_public": {
        "name": "myLobbyName",
        "pwd": "mySecretCode"
    }
}

A new field named "publicSettings" will be returned in the response.

{
  "publicSettings": {
      "name": "myLobbyName",
      "pwd": "mySecretCode"
  }
}

JSON Response

{
    "data": {
        "lobbiesByRating": {
            "20.0": [
                {
                    "id": "23782:Relay_lobbyT_v2:2",
                    "lobbyType": "Relay_lobbyT_v2",
                    "state": "setup",
                    "rating": 20,
                    "desc": "starts as soon as 1 player is ready",
                    "owner": {
                        "profileId": "10b6d6fa-0aa6-43b0-a7b3-48aff2d13312",
                        "name": "",
                        "rating": 0,
                        "pic": null,
                        "cxId": "23782:10b6d6fa-0aa6-43b0-a7b3-48aff2d13312:52kc0h19k0pnnjhnrp8pug7udd"
                    },
                    "numMembers": 1,
                    "maxMembers": 8,
                    "publicSettings": {
                        "name": "myLobbyName",
                        "pwd": "mySecretCode"
                    }
                }
            ]
        }
    },
    "status": 200
}