WebStorage

Set this property temporarily to true to clear all local data and also all web data at app startup. All previously stored web data is also removed, so use this property carefully.

This is only useful during testing, if you have faulty local and web data.

See also clearAll().

Set this property temporarily to true to clear all local data at app startup. The storage will then be synced with the web contents and all local changes are lost.

This is only useful during testing, if you have faulty local data or want to simulate a fresh connection from a device.

See also clearAllLocally().

This property can either have the value "serverDataMergesClientData", "clientDataMergesServerData", "serverDataOverwritesClientData", "clientDataOverwritesServerData", or "userResolve". The default value is "serverDataMergesClientData", so the data from the server takes precedence over the client data.

Based on the dataConflictStrategy, these are the results for different scenarios:

Case 1: Values

• var serverData = 10
• var clientData = 20
• "serverDataMergesClientData": 10
• "clientDataMergesServerData": 20

Case 2: Maps

• var serverData = {"key1":"value2","key3":3,"boolKey1":false}
• var clientData = {"key1":"value1","key2":2,"boolKey1":true}
• "serverDataMergesClientData": {"key1":"value2","key2":2,"boolKey1":false,"key3":3}
• "clientDataMergesServerData": {"key1":"value1","key2":2,"boolKey1":true,"key3":3}

Case 3: Arrays

• var serverData = [1,2,{"inArrayServerKey":"hi"}]
• var clientData = [3,4,5,6,7,{"inArrayClientKey":"myClient"}]
• "serverDataMergesClientData": [1,2,{"inArrayServerKey":"hi"},6,7,{"inArrayClientKey":"myClient"}]
• "clientDataMergesServerData": [3,4,5,6,7,{"inArrayClientKey":"myClient"}]

Case 4: Complex structure (mix of all above)

• var serverData = {"key1":"value2","key3":3,"array1":[1,2,3,4]}
• var clientData = {"key1":"value1","key2":2,"array1":[5,6]}
• "serverDataMergesClientData": {"key1":"value2","key2":2,"array1":[1,2,3,4],"key3":3}
• "clientDataMergesServerData": {"key1":"value1","key2":2,"array1":[5,6,3,4],"key3":3}

Set this property to store the key-value pairs to a database file with this name. By default, the databaseName is "defaultDBName". Multiple instances of the Storage element with the same databaseName have access to the same data set.

Note: The GameWindow::settings property uses the databaseName "settings" internally, so do not use this value.

See also Storage::databaseName.

Set this property to the id of Felgo Game Network.

By default, it will be set to the id gameNetwork if one is found in the project, or it is undefined if no such id is found.

Note: It is required that a Felgo Game Network component exists for this component to synchronize the data with the web server.

This is an example how to use it:

 // ...

 FelgoGameNetwork {
   id: myGameNetwork

   // other gameNetwork code here
 }

 WebStorage {
   id: myGameNetworkView

   gameNetworkItem: myGameNetwork
 }

 // ...

A map of keys that should not be synced with the server. These keys are not synced with the cloud and thus the WebStorage behaves like a normal Storage component without syncing them.

An example value is: {"ignoredKey1", "ignoredKey2"}

This read-only property gets true when all read or write requests are handled and all data is in sync. It stays at the initial value false when a connection error occurs and the write requests are stored for later sending. It also changes to false when data is written with setValue() or when a server value is synced initially at app startup, and also after initiallyInServerSync is true.

This read-only property gets true the first time all the keys are synced with the server. At app start it is set to false and stays false if a connection error occurs.

This property is similar to inServerSync because it is also set to true when all properties are in sync with server. The difference is that it does not get set to false at a further call of setValue(), but stays true. It only gets false when when the logged in player changes (e.g. at a call of FelgoGameNetwork::connectFacebookUser() or FelgoGameNetwork::disconnectFacebookUser()).

It is also similar to initiallyInServerSyncOrError, with the difference it is only set to true when no connection error occurred and all key-value pairs are in sync.

See also initiallyInServerSyncOrError and inServerSync.

This read-only property gets true the first time all the keys are synced with the server or there is no Internet connection.

See also initiallyInServerSync and inServerSync.

This property holds if it should sync across all devices of the same user (the default value true), or sync across all users and all devices (set it to false in that case).

See also WebStorage Per User or Per Application.

This handler is called when a value was successfully cleared from the server after an explicit call of clearValue().

The data argument has the following format:

 {
   "key": "testKey"
 }

Note: The corresponding handler is onClearValueFinished.

This handler is called if a connection error occurred and thus the key-value pairs are not in sync with the server. You can for example show a dialog to the user if that happens.

Note: The corresponding handler is onErrorAndNotInitiallySynced.

This handler is called when a value is read from the server either after an explicit call of getValue() or after syncing all keys at app start.

The data argument has the following format:

 {
   "key": "testKey",
   "value": "serverValue"
 }

Note: The corresponding handler is onReadValueFinished.

This handler is called when a call of setValue() was not successful, because the server data got modified from another device compared to the (old) local data. If dataConflictStrategy is set to "userResolve", the mergedData is undefined but conflict is true.

Example value for data property:

 {
   "key": "testKey",
   "value": "serverValue",
   "updated_at": "2013-06-12T14:26:10Z",
   "client_value": "clientValue",
   "client_updated_at": "2013-06-11T14:26:10Z",
   "conflict": true,
   "mergedData": "serverValue"
 }

In this handler, you can call setValue() with your custom merged value if dataConflictStrategy is set to "userResolve".

Note: The corresponding handler is onWriteConflict.

This handler is called when a value was successfully written to the server after an explicit call of setValue().

The data argument has the following format:

 {
   "key": "testKey",
   "value": "serverValue"
 }

Note: The corresponding handler is onWriteValueFinished.

Clears all values for all keys of this WebStorage locally and on the server. To only clear the local data but not on the server, call clearAllLocally().

Note: This clears all data locally and on the server, so if you provide this functionality in your game add at least a security check if the user really wants to do that.

Internally, this function calls clearValue() for all keys, so for each key a onClearValueFinished is called.

See also clearAllLocally(), Storage::clearAll(), and clearAllAtStartup.

Clears all the local data stored with WebStorage, without clearing the values on the server.

This is useful if you want to provide a logout functionality because the user for example sells the device, and does not want to keep his played data on the device. The server data, however, should not be deleted because the player might continue to play from another device and by connecting with Facebook he can then continue playing with the same server data.

The suggested workflow contains a messagebox to ask if the user wants to remove all his local player progress after a logout, which most of the time he will want to do. Otherwise the local data will be written and merged to the newly logged in user. Make sure to call the clearAllLocally() before the new user is logged in again, otherwise the local data was already written to the server.

Note: Highscores and achievements of FelgoGameNetwork are never stored locally and always get overwritten by the server data once another user logs in. So no dedicated removal of client data is required for higshcores and achievements.

See also clearAll(), Storage::clearAll(), and clearAllLocallyAtStartup.

Clears the value for the provided key so its value is undefined.

If a callback function is provided, it is called after the data was cleared at the server.

The handler onClearValueFinished is also called after a successful write to the server.

See also getValue(), setValue(), clearValueFinished, writeConflict, and Storage::clearValue().

Returns the previously stored value with setValue() for key from the WebStorage or undefined if nothing was stored for this key before.

If a callback function is provided, it is called after the data was synced and possibly merged with the server.

The handler onReadValueFinished is also called after a successful write to the server.

See also setValue(), readValueFinished, and Storage::getValue().

Stores the value with the provided key permanently to the WebStorage. It is stored to the local database immediately and is accessible with getValue().

If a callback function is provided, it is called after the data was synced and possibly merged with the server.

The handler onWriteValueFinished is also called after a successful write to the server.

See also getValue(), writeValueFinished, writeConflict, and Storage::setValue().

Call this function to synchronize all local values with the server and auto-merge them based on the dataConflictStrategy.