The ICloudRecord interface.
More...
#include <murl_i_cloud_record.h>
The ICloudRecord interface.
ICloud records can be created by the ICloudControl interface.
Inherited by Murl::Platform::Foundation::CloudRecord.
◆ Status
Enumeration of the record states.
Use GetStatus() to get the current status.
Enumerator |
---|
STATUS_IDLE | The record is idle.
|
STATUS_READY | The record is ready to set/get key/values.
|
STATUS_LOADING | The record is loading.
|
STATUS_SAVING | The record is saving.
|
STATUS_DELETING | The record is deleting.
|
STATUS_ERROR | The record has an error.
|
◆ GetStatus()
virtual Status Murl::ICloudRecord::GetStatus |
( |
| ) |
const |
|
pure virtual |
Get the cloud record status.
LoadRecord(), SaveRecord() and DeleteRecord() operation works asynchronously, the application can check the current status to operate correctly.
- Returns
- The cloud record status.
◆ LoadRecord()
virtual Bool Murl::ICloudRecord::LoadRecord |
( |
| ) |
|
|
pure virtual |
◆ SaveRecord()
virtual Bool Murl::ICloudRecord::SaveRecord |
( |
| ) |
|
|
pure virtual |
◆ DeleteRecord()
virtual Bool Murl::ICloudRecord::DeleteRecord |
( |
| ) |
|
|
pure virtual |
◆ KeyExists()
virtual Bool Murl::ICloudRecord::KeyExists |
( |
const String & |
key | ) |
const |
|
pure virtual |
Check if a key exists.
- Parameters
-
- Returns
- true if the key exists, false if the key does not exist or the record status is not ICloudRecord::STATUS_READY.
◆ DeleteKey()
virtual Bool Murl::ICloudRecord::DeleteKey |
( |
const String & |
key | ) |
|
|
pure virtual |
◆ GetStringValue()
virtual Bool Murl::ICloudRecord::GetStringValue |
( |
const String & |
key, |
|
|
String & |
value |
|
) |
| const |
|
pure virtual |
Get a string value by a key.
- Parameters
-
key | The key name string. |
value | The string return value. |
- Returns
- true if successful, false if the key does not exist or the record status is not ICloudRecord::STATUS_READY.
◆ SetStringValue()
virtual Bool Murl::ICloudRecord::SetStringValue |
( |
const String & |
key, |
|
|
const String & |
value |
|
) |
| |
|
pure virtual |
Set a string value for a key.
- Parameters
-
key | The key name string. |
value | The string value to set. |
- Returns
- true if successful, false if the record status is not ICloudRecord::STATUS_READY.
◆ GetDoubleValue()
virtual Bool Murl::ICloudRecord::GetDoubleValue |
( |
const String & |
key, |
|
|
Double & |
value |
|
) |
| const |
|
pure virtual |
Get a double value by a key.
- Parameters
-
key | The key name string. |
value | The double return value. |
- Returns
- true if successful, false if the key does not exist or the record status is not ICloudRecord::STATUS_READY.
◆ SetDoubleValue()
virtual Bool Murl::ICloudRecord::SetDoubleValue |
( |
const String & |
key, |
|
|
Double |
value |
|
) |
| |
|
pure virtual |
Set a double value for a key.
- Parameters
-
key | The key name string. |
value | The double value to set. |
- Returns
- true if successful, false if the record status is not ICloudRecord::STATUS_READY.
◆ GetIntValue()
virtual Bool Murl::ICloudRecord::GetIntValue |
( |
const String & |
key, |
|
|
SInt64 & |
value |
|
) |
| const |
|
pure virtual |
Get an integer value by a key.
- Parameters
-
key | The key name string. |
value | The integer return value. |
- Returns
- true if successful, false if the key does not exist or the record status is not ICloudRecord::STATUS_READY.
◆ SetIntValue()
virtual Bool Murl::ICloudRecord::SetIntValue |
( |
const String & |
key, |
|
|
SInt64 |
value |
|
) |
| |
|
pure virtual |
Set an integer value for a key.
- Parameters
-
key | The key name string. |
value | The integer value to set. |
- Returns
- true if successful, false if the record status is not ICloudRecord::STATUS_READY.
◆ GetDataValue()
virtual Bool Murl::ICloudRecord::GetDataValue |
( |
const String & |
key, |
|
|
Data & |
value |
|
) |
| const |
|
pure virtual |
Get a data value by a key.
- Parameters
-
key | The key name string. |
value | The data return value. |
- Returns
- true if successful, false if the key does not exist or the record status is not ICloudRecord::STATUS_READY.
◆ SetDataValue()
virtual Bool Murl::ICloudRecord::SetDataValue |
( |
const String & |
key, |
|
|
const Data & |
value |
|
) |
| |
|
pure virtual |
Set a data value for a key.
- Parameters
-
key | The key name string. |
value | The data value to set. |
- Returns
- true if successful, false if the record status is not ICloudRecord::STATUS_READY.
The documentation for this interface was generated from the following file: