CloudOnce v2.7.5
Unified Game Services API
CloudOnce.CloudPrefs.CloudString Class Reference

Used to store strings in the cloud. More...

Inheritance diagram for CloudOnce.CloudPrefs.CloudString:
[legend]
Collaboration diagram for CloudOnce.CloudPrefs.CloudString:
[legend]

Public Member Functions

 CloudString (string key, PersistenceType persistenceType=PersistenceType.Latest, string value="")
 Used to store strings in the cloud. More...
 
 CloudString (string key, PersistenceType persistenceType, string value, string defaultValue)
 Used to store strings in the cloud. More...
 
- Public Member Functions inherited from CloudOnce.Internal.PersistentValue< string >
void Load (bool force=false)
 Invokes the ValueLoader.
 
void Flush ()
 Invokes the ValueSetter.
 
void Reset ()
 Resets the value back to it's default value.
 

Additional Inherited Members

- Protected Member Functions inherited from CloudOnce.Internal.PersistentValue< string >
 PersistentValue (string key, PersistenceType type, T value, T defaultValue, ValueLoaderDelegate valueLoader, ValueSetterDelegate valueSetter)
 A preference that is stored in the cloud. Automatically added to the DataManager. More...
 
delegate T ValueLoaderDelegate (string key, T defaultValue)
 
delegate void ValueSetterDelegate (string key, T value, PersistenceType persistenceType)
 
- Properties inherited from CloudOnce.Internal.PersistentValue< string >
string Key [get]
 The unique identifier used to identify this particular value.
 
Value [get, set]
 The current value for this preference. Takes PersistenceType into account when setting.
 
PersistenceType PersistenceType [get]
 The method of conflict resolution to be used in case of a data conflict. Can happen if the data is altered by a different device.
 
DefaultValue [get]
 The value the preference will be set to if it is ever reset.
 

Detailed Description

Used to store strings in the cloud.

Constructor & Destructor Documentation

◆ CloudString() [1/2]

CloudOnce.CloudPrefs.CloudString.CloudString ( string  key,
PersistenceType  persistenceType = PersistenceType.Latest,
string  value = "" 
)
inline

Used to store strings in the cloud.

Parameters
keyA unique identifier used to identify this particular value.
persistenceTypeThe method of conflict resolution to be used in case of a data conflict. Can happen if the data is altered by a different device. PersistenceType.Latest will prefer the latest (newest) string. PersistenceType.Highest will prefer the longest string. PersistenceType.Lowest will prefer the shortest string. If you use PersistenceType.Lowest and don't set an initial value, the string will always be empty.
valueThe starting value for this string.

◆ CloudString() [2/2]

CloudOnce.CloudPrefs.CloudString.CloudString ( string  key,
PersistenceType  persistenceType,
string  value,
string  defaultValue 
)
inline

Used to store strings in the cloud.

Parameters
keyA unique identifier used to identify this particular value.
persistenceTypeThe method of conflict resolution to be used in case of a data conflict. Can happen if the data is altered by a different device. PersistenceType.Latest will prefer the latest (newest) string. PersistenceType.Highest will prefer the longest string. PersistenceType.Lowest will prefer the shortest string. If you use PersistenceType.Lowest and don't set an initial value, the string will always be empty.
valueThe starting value for this string.
defaultValueThe value the string will be set to if it is ever reset.

The documentation for this class was generated from the following file: