Skip to main content
Version: 5.18.17

GetCollectionNames

public BackendCloudSaveCollectionReturnObject GetCollectionNames();

Description​

Loads the list of collections registered in the console.

  • This method cannot be called using SendQueue.

BackendCloudSaveCollectionReturnObject​

namespace BackEnd.Functions
{
    public sealed class BackendCloudSaveCollectionReturnObject : BackendReturnObject
    {   
        public List<string> GetCollectionNameList()
    }
}

Example​

Synchronous​

var bro = Backend.CloudSave.GetCollectionNames();
if (bro.IsSuccess())
{
    foreach(var name in bro.GetCollectionNameList()) 
    {    
        Debug.Log(name);
    }
}

Asynchronous​

Backend.CloudSave.GetCollectionNames(bro =>
{
    if (bro.IsSuccess())
    {
        foreach(var name in bro.GetCollectionNameList()) 
        {    
            Debug.Log(name);
        }
    }    
});

ReturnCase​

Success cases​

When at least one collection exists

StatusCode : 200

Message : Success

ReturnValue : Refer to GetReturnValuetoJSON

When no collections exist

StatusCode : 200

Message : Success

ReturnValue : {"result":[]}

GetReturnValuetoJSON​

{
    "result": [
        {
            "name": "collection_01"            
        },
        {
            "name": "collection_02"           
        },
        {
            "name": "collection_03"                
        }
    ]
}