Transaction (key/value storage, also called "units") related tasks

Functions
void	CloudBuilder::CUserManager::Balance (const char *aDomain, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::TxHistory (const char *aDomain, const CotCHelpers::CHJSON *aJSONOptions, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::GetValue (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::SetValue (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::DeleteValue (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::GetBinary (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::SetBinary (const CotCHelpers::CHJSON *aConfiguration, const void *aPointer, size_t aSize, CResultHandler *aHandler)
void	CloudBuilder::CUserManager::DeleteBinary (const CotCHelpers::CHJSON *aConfiguration, CResultHandler *aHandler)

Detailed Description

Function Documentation

Balance()

void CloudBuilder::CUserManager::Balance	(	const char *	aDomain,
		CResultHandler *	aHandler
	)

Method to retrieve the user's balance.

Parameters

aDomain	the domains on which action must be taken. NULL is used for "private", which means it can only be accessed from this game.
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { "Gold" : 100, "Silver" : 10 }

DeleteBinary()

void CloudBuilder::CUserManager::DeleteBinary	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method to remove data pointed by a single key.

Parameters

aConfiguration	JSON allowing for extensible configuration, that may contain: domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to delete
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { "done" : 1, }

DeleteValue()

void CloudBuilder::CUserManager::DeleteValue	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method to delete a single key of the global JSON object stored for this user and domain.

Parameters

aConfiguration	is a JSON configuration, that may contain domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to delete from the global JSON object. BEWARE: if you omit the key, ALL entries will be deleted!
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr and no binary key was passed in the configuration, the json passed to the handler may contain: { "done": 1 }

GetBinary()

void CloudBuilder::CUserManager::GetBinary	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method to read a single key containing binary data stored for this user and this domain.

Parameters

aConfiguration	JSON allowing for extensible configuration, that may contain: domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to retrieve
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { "url" : "<signed URL>", } CCloudResult.HasBinary() must be true and you can acces to the data through :

GetValue()

void CloudBuilder::CUserManager::GetValue	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method to read a single key of the global JSON object stored for this user and this domain.

Parameters

aConfiguration	is a JSON configuration, that may contain domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to retrieve from the global JSON object (if not passed, all keys are returned)
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr and no binary key was passed in the configuration, the json passed to the handler may contain: { "<key1>" : "value1", "<key2>" : "value2", ... }

SetBinary()

void CloudBuilder::CUserManager::SetBinary	(	const CotCHelpers::CHJSON *	aConfiguration,
		const void *	aPointer,
		size_t	aSize,
		CResultHandler *	aHandler
	)

Method to insert or modify a single key represented by binary data Please note that if you have used KeyValueWrite with a key you reuse in BinaryWrite, you will lose your initial JSON data.

Parameters

aConfiguration	JSON allowing for extensible configuration, that may contain: domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to write to
aPointer	is the binary array you want to save.
aSize	is the size of the binary array, in bytes.
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { "url" : "<signed URL>", }

SetValue()

void CloudBuilder::CUserManager::SetValue	(	const CotCHelpers::CHJSON *	aConfiguration,
		CResultHandler *	aHandler
	)

Method to insert a key or modify the global JSON object stored for this user and this domain. Please note that if you have used BinaryWrite with a key you reuse in KeyValueWrite, you will lose your initial binary data.

Parameters

aConfiguration	JSON allowing for extensible configuration, that may contain: domain: the domain on which the action is to be taken (if not passed, the private domain is used) key: name of the key to write to (if not passed, the JSON itself is replaced) data: a JSON containing the object to write
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain: { "<key1>" : "value1", "<key2>" : "value2", ... }

TxHistory()

void CloudBuilder::CUserManager::TxHistory	(	const char *	aDomain,
		const CotCHelpers::CHJSON *	aJSONOptions,
		CResultHandler *	aHandler
	)

Method to retreive the history of transactions for this user.

Parameters

aDomain	the domains on which action must be taken. NULL is used for "private", which means it can only be accessed from this game.
aJSONOptions	specify skip and limit and/or the currency for the history, if empty returns all the transactions. i.e. { "unit" : "Gold", "skip": 10, "limit" : 10}
aHandler	result handler whenever the call finishes (it might also be synchronous)

Returns

if noErr, the json passed to the handler may contain:

"servertime":   "2014-10-06T13:59:04.308Z", -- server actual time, to synchronize before any new transaction if needed
"history":  [{
    "domain":   "com.clanofthecloud.cloudbuilder.xxxx",
    "ts":   "2014-10-06T05:05:38.764Z",
    "tx":   {
        "Gold": -100,
        "Silver":   1
    },
    "desc": "Unit Testing transactions, Zeroing Gold"
}, {
    "domain":   "com.clanofthecloud.cloudbuilder.xxx",
    "ts":   "2014-10-06T05:05:38.749Z",
    "tx":   {
    "Gold": 100
    },
    "desc": "Unit Testing transactions"
}] -- ordered by descending time