Skip to main content
Version: 5.17.0

GetChartListV2

public BackendReturnObject GetChartListV2();

Note on function improvement

The new CDN chart feature, which significantly improves the speed of the existing chart functionality, is now available.\ Please use this feature for much faster data look up and storage.

Description

Looks up charts registered in BACKND Console.\ The chart is data from the Excel file uploaded to and applied in the chart management section of BACKND Console.

Upon lookup, the chart name, chart ID/UUID, and the chart's version are returned, and chart data is not included.

Differences with GetChartList

There are a few differences between this and GetChartList.

  • Charts where files cannot be applied are excluded
  • JSON return values do not have the 'old' column.
Note on migration from GetChartList

Check the following when migrating from the GetChartList() method to the GetChartListV2() method:

  • If 'old' is used for parsing JSON(e.g., json["rows"][0]["S"]["old"].ToString())

  • If there is a logic for charts without files applied
    \ :::

Example

Synchronous

Backend.Chart.GetChartListV2();

Asynchronous

Backend.Chart.GetChartListV2((callback) => {
// Post-process
});

SendQueue

SendQueue.Enqueue(Backend.Chart.GetChartListV2, (callback) => {
// Post-process
});

ReturnCase

Success cases

When the lookup is successful\ statusCode : 200\ message : Success\ returnValue : refer to GetReturnValuetoJSON

GetReturnValuetoJSON

{
rows:
[
{
// Chart name
chartName: { S: "Monster chart" },
// Chart description
chartExplain: { NULL: true },
// Applied chart file id(if present)
selectedChartFileId: { N: "47" },
},
{
chartName: { S: "ItemChart" },
chartExplain: { S : "This chart has item information." },
selectedChartFileId: { N: "47423" },
}
]
}

Sample Code

public class ChartCardV2
{
public string chartName; // Chart name
public string chartExplain; // Chart description
public int selectedChartFileId;// Chart file ID

public override string ToString()
{
return $"chartName: {chartName}\n" +
$"chartExplain: {chartExplain}\n" +
$"selectedChartFileId: {selectedChartFileId}\n";
}
}
public void GetChartListV2Test()
{
var bro = Backend.Chart.GetChartListV2();

if(!bro.IsSuccess())
{
Debug.LogError("An error occurred : " + bro.ToString());
return;
}

List<ChartCardV2> chartCardList = new List<ChartCardV2>();

LitJson.JsonData json = bro.FlattenRows();

for(int i = 0; i < json.Count; i++)
{
ChartCardV2 chartCard = new ChartCardV2();

chartCard.chartName = json[i]["chartName"].ToString();
chartCard.chartExplain = json[i]["chartExplain"].ToString();
chartCard.selectedChartFileId= json[i]["selectedChartFileId"].ToString();

chartCardList.Add(chartCard);
}

foreach(var chartCard in chartCardList)
{
Debug.Log(chartCard.ToString() + "\n");
}
}