ReadGroup

Retrieve information about the group.

Service	Operation
group	READ_GROUP

Method Parameters

Parameter	Description
groupId	ID of the group

Usage

http://localhost:3000

C#

string groupId = "a-group-id";
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.Group.ReadGroup(groupId, successCallback, failureCallback);

C++

const char *groupId = "a-group-id";

_bc->getGroup()->readGroup(groupId, this);

Objective-C

NSString *groupId = @"a-group-id";
BCCompletionBlock successBlock;      // define callback
BCErrorCompletionBlock failureBlock; // define callback

[[_bc groupService] readGroup:groupId
            completionBlock:successBlock
       errorCompletionBlock:failureBlock
                   cbObject:nil];

Java

String groupId = "a-group-id";
this; // implements IServerCallback

_bc.getGroup().readGroup(groupId, 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 groupId = "a-group-id";

_bc.group.readGroup(groupId, result =>
{
    var status = result.status;
    console.log(status + " : " + JSON.stringify(result, null, 2));
});

Dart

var  groupId = "a-group-id";

ServerResponse result = await _bc.groupService.readGroup(groupId:groupId);

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

Cloud Code

var groupId = "a-group-id";
var groupProxy = bridge.getGroupServiceProxy();

var postResult = groupProxy.readGroup(groupId);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "group",
    "operation": "READ_GROUP",
    "data": {
        "groupId": "a-group-id"
    }
}

JSON Response

{
  "data": {
    "gameId": "13229",
    "groupId": "d373ff92-3327-4176-85ed-3565a09c43fa",
    "ownerId": "8bd564a7-3f91-4a98-a4b3-43cd7d266133",
    "name": "agroup",
    "groupType": "group11",
    "createdAt": 1605155742940,
    "updatedAt": 1671123804120,
    "members": {
      "8bd564a7-3f91-4a98-a4b3-43cd7d266133": {
        "role": "OWNER",
        "attributes": {}
      },
      "79087465-5ca5-41a1-9d46-85ad23bc6efd": {
        "role": "MEMBER",
        "attributes": {}
      }
    },
    "pendingMembers": {},
    "version": 5,
    "data": {
      "indexedId": "groupblue"
    },
    "summaryData": {},
    "isOpenGroup": true,
    "defaultMemberAttributes": {},
    "memberCount": 2,
    "invitedPendingMemberCount": 0,
    "requestingPendingMemberCount": 0,
    "acl": {
      "member": 2,
      "other": 0
    }
  },
  "status": 200
}