![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The ICloudRecord interface.
ICloud records can be created by the ICloudControl interface.
Enumeration of the record states. Use GetStatus() to get the current status.
Murl.ICloudRecord.STATUS_IDLE | The record is idle. |
Murl.ICloudRecord.STATUS_READY | The record is ready to set/get key/values. |
Murl.ICloudRecord.STATUS_LOADING | The record is loading. |
Murl.ICloudRecord.STATUS_SAVING | The record is saving. |
Murl.ICloudRecord.STATUS_DELETING | The record is deleting. |
Murl.ICloudRecord.STATUS_ERROR | The record has an error. |
Get the cloud record status. LoadRecord(), SaveRecord() and DeleteRecord() operation works asynchronously, the application can check the current status to operate correctly.
Murl.ICloudRecord.Status GetStatus()
Load the record. After creating an ICloudRecord object or deleting a record, the status is ICloudRecord::STATUS_IDLE. First of all this method must be called to get the record ready. If the status is ICloudRecord::STATUS_ERROR this method can be called to re-load the record.
When start loading, the status changes to ICloudRecord::STATUS_LOADING immediately. When the loading is finished, the status changes to ICloudRecord::STATUS_READY. In case of any error the status changes to ICloudRecord::STATUS_ERROR.
Boolean LoadRecord()
Save the record. When start saving, the status changes to ICloudRecord::STATUS_SAVING immediately. When the saving is finished, the status changes to ICloudRecord::STATUS_READY. In case of any error the status changes to ICloudRecord::STATUS_ERROR.
Boolean SaveRecord()
Delete the record. When start deleting, the status changes to ICloudRecord::STATUS_DELETING immediately. When the deletion is finished, the status changes to ICloudRecord::STATUS_IDLE.
In case of any error the status changes to ICloudRecord::STATUS_ERROR.
Boolean DeleteRecord()
Check if a key exists.
key | The key name string. |
Delete a key.
key | The key name string. |
Get a string value by a key.
Boolean, String GetStringValue(String key, String value)
key | The key name string. |
value | The string return value. |
Set a string value for a key.
Boolean SetStringValue(String key, String value)
key | The key name string. |
value | The string value to set. |
Get a double value by a key.
Boolean, Number GetDoubleValue(String key, Number value)
key | The key name string. |
value | The double return value. |
Set a double value for a key.
Boolean SetDoubleValue(String key, Number value)
key | The key name string. |
value | The double value to set. |
Get an integer value by a key.
Boolean, Integer GetIntValue(String key, Integer value)
key | The key name string. |
value | The integer return value. |
Set an integer value for a key.
Boolean SetIntValue(String key, Integer value)
key | The key name string. |
value | The integer value to set. |
Get a data value by a key.
Boolean, Murl.Data GetDataValue(String key, Murl.Data value)
key | The key name string. |
value | The data return value. |
Set a data value for a key.
Boolean SetDataValue(String key, Murl.Data value)
key | The key name string. |
value | The data value to set. |