Skip to main content
Version: 5.15.0

Table.Get

public BackendGroupReturnObject Get(int limit, LastEvaluatedKey lastEvaluatedKey);
public BackendGroupReturnObject Get(int limit);
public BackendGroupReturnObject Get();

Parameters

Parameters

ValueTypeDescription
limit100Maximum number of groups to load
lastEvaluatedKeyLastEvaluatedKeyWhen trying to load more groups than the 'limit', the following groups can be loaded through bro.GetLastEvaluatedKey().

Description

Loads the group list registered to the console.

  • This method cannot be called via SendQueue.

BackendGroupReturnObject

namespace BackEnd.Group
{
public class GroupItem
{
public readonly string userCount = string.Empty;
public readonly string groupUuid = string.Empty;
public readonly string groupName = string.Empty;
}

public class BackendGroupReturnObject : BackendReturnObject
{
public List<GroupItem> GetGroupList();
}
}

Example

Synchronous

BackEnd.Group.BackendGroupReturnObject bro = Backend.Group.Table.Get();

foreach(BackEnd.Group.GroupItem groupItem in bro.GetGroupList())
{
string groupUUID = groupItem.groupUuid;
string groupName = groupItem.groupName;
Debug.Log(groupItem);
}

Asynchronous

Backend.Group.Table.Get(callback => {
foreach(BackEnd.Group.GroupItem groupItem in bro.GetGroupList())
{
string groupUUID = groupItem.groupUuid;
string groupName = groupItem.groupName;
Debug.Log(groupItem);
}
});

ReturnCase

Success cases

When loaded successfully
StatusCode : 200
Message : Success
ReturnValue : refer to GetReturnValuetoJSON

Error cases

When the group does not exist StatusCode : 200
ErrorCode : Success
Message : {"rows":[]}

GetReturnValuetoJSON

{
"rows": [
{
"groupName": "USA",
"groupUuid": "01920430-b9de-7865-a170-ec03ef6dceb3",
"userCount": 100
},
{
"groupName": "ASIAN",
"groupUuid": "01920430-a2de-78cf-94fe-d106d73b86d4",
"userCount": 10
},
{
"groupName": "TEST_GROUP",
"groupUuid": "01920430-d6d9-7493-afc6-9b49b6c6fef3",
"userCount": 0
}
]
}