SysGetRandomGroupsMatching

Gets a list of up to maxReturn randomly selected groups from the server based on the where condition, bypassing ownership/ACL checks.

Service	Operation
group	SYS_GET_RANDOM_GROUPS_MATCHING

Method Parameters

Parameter	Description
where	A mongo style query string.
maxReturn	The max count of groups to randomly select.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Objective-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var where = {
  "groupType": "BLUE"
};
var maxReturn = 20;
var groupProxy = bridge.getGroupServiceProxy();

var postResult = groupProxy.sysGetRandomGroupsMatching(where, maxReturn);
if (postResult.status == 200) {
  // Success!
}

Raw

{
  "service": "group",
  "operation": "SYS_GET_RANDOM_GROUPS_MATCHING",
  "data":
  {
    "where": {
      "groupType": "BLUE"
    },
    "maxReturn": 20
  }
}

JSON Response

{
  "data": {
    "count": 1,
    "groups": [
      {
        "gameId": "23782",
        "groupId": "2bf538d1-19ea-4e14-9862-f979215e09b7",
        "ownerId": "7f06ee4d-bc40-48ea-aa27-d3b73059491b",
        "name": "gname1",
        "groupType": "group1",
        "createdAt": 1594906094270,
        "updatedAt": 1594906094270,
        "members": {
          "10b6d6fa-0aa6-43b0-a7b3-48aff2d13312": {
            "role": "MEMBER",
            "attributes": {}
          },
          "7f06ee4d-bc40-48ea-aa27-d3b73059491b": {
            "role": "OWNER",
            "attributes": {}
          }
        },
        "pendingMembers": {
          "10b6d6fa-0aa6-43b0-a7b3-48aff2d13312": {
            "role": "MEMBER",
            "attributes": {},
            "pendingReason": "INVITED_TO_JOIN"
          }
        },
        "version": 1,
        "data": {},
        "summaryData": {},
        "isOpenGroup": true,
        "defaultMemberAttributes": {},
        "memberCount": 2,
        "invitedPendingMemberCount": 1,
        "requestingPendingMemberCount": 0,
        "acl": {
          "member": 2,
          "other": 2
        }
      }
    ]
  },
  "status": 200
}