GetChartByFolderAndSave
public BackendReturnObject GetChartByFolderAndSave(int folderId, bool isChartKeyIsName);
Parameters
Value | Type | Description |
---|---|---|
folderId | int | Chart folder ID |
isChartKeyIsName | bool | Whether to use the chart name as the key value of the chart to be saved |
true : Use the chart name specified in BACKND Console as the key value
false : Use the chart's {uuid/id} as the key value
Description
Calls and saves all chart file content under the specified folder created in BACKND Console's chart management.
- Depending on the parameters entered, the chart ID or the chart name set in BACKND Console is applied as the key.
- The content of the currently applied chart file is saved as the value.
- If there is no currently applied chart, it will not be saved.
Example
Synchronous
Backend.Chart.GetChartByFolderAndSave(1024, true);
Asynchronous
Backend.Chart.GetChartByFolderAndSave(1024, true, callback =>
{
// Post-process
});
SendQueue
SendQueue.Enqueue(Backend.Chart.GetChartByFolderAndSave, 1024, true, callback =>
{
// Post-process
});
Return cases
Success cases
When the lookup is successful
statusCode : 200
returnValue : refer to GetReturnValuetoJSON
GetReturnValuetoJSON
{
rows:
[
// version 1(old)
// When selectedChartFile does not exist
{
// Chart uuid
uuid: { S: "538b3a20-7b7a-11e8-8002-f31a1dd37719" },
// Chart indate
inDate: { S: "2018-06-29T08:56:35.266Z" },
// Chart description
chartExplain: { S: "2" },
// Chart name
chartName: { S: "v1" },
// version information(y: version1, n: version2)
old: { S: "y" }
},
// version 1(old)
// When selectedChartFile exists
{
// File information applied to the chart
selectedChartFile:
{
M:
{
// Number of rows in the chart
count: { N: "1000" },
// Chart file uuid
uuid: { S: "780932f0-75fb-11e8-bf7a-cbcc37090d69" },
// Chart file indate
inDate: { S: "2018-06-22T09:05:54.591Z" },
// Chart file name
chartFileName: { S: "222222.xlsx" }
}
},
// Chart indate
inDate: { S: "2018-06-22T09:05:38.562Z" },
// Chart uuid
uuid: { S: "6e7b5e20-75fb-11e8-bf7a-cbcc37090d69" },
// Chart description
chartExplain: { S: "v1" },
// Chart name(used when saving the chart content for selectedChartFile to PlayerPrefs)
chartName: { S: "23" },
// version information(y: version1, n: version2)
old: { S: "y" }
},
// version 2(new)
// When selectedChartFile does not exist
{
// Chart name
chartName: { S: "gggg" },
// Chart description
chartExplain: { NULL: true },
// Applied chart file id(if non-existent)
selectedChartFileId: { NULL: true },
// version information(y: version1, n: version2)
old: { S: "n" }
},
// version 2(new)
// When selectedChartFile exists
{
// Chart name
chartName: { S: "Heyhey" },
// Chart description
chartExplain: { NULL: true },
// Applied chart file id(if present)
selectedChartFileId: { N: "47" },
// version information(y: version1, n: version2)
old: { S: "n" }
}
]
}