CloudStore
ClassAn instance of Cloud Storage that can store data in a multiplayer experience.
- Available on all platforms
Since Lens Scripting v173
Not available on SPECS. Use Snap Cloud for persistence there instead.
Index
Mobile Only
Extends
Methods
deleteValue()
deleteValue(
key,readOptions,onDeleted,onError):void
Deletes a value from the persistence backend. Note that the scope must match that which was used when the value was originally saved.
Parameters
| Parameter | Type |
|---|---|
key | string |
readOptions | CloudStorageReadOptions |
onDeleted | () => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 173
Mobile Only
getTypeName()
staticgetTypeName():TypeName<CloudStore>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<CloudStore>
Since
Lens Scripting Version 173
Mobile Only
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
getValue()
getValue(
key,readOptions,onRetrieved,onError):void
Gets a value from the persistence backend. Note that scope must match that which was used when the value was originally saved.
Parameters
| Parameter | Type |
|---|---|
key | string |
readOptions | CloudStorageReadOptions |
onRetrieved | (key, value) => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 173
Mobile Only
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
listValues()
listValues(
listOptions,onRetrieved,onError):void
Lists values from the persistence backend. Note that the scope must match that which was used when the values were originally saved.
Parameters
| Parameter | Type |
|---|---|
listOptions | CloudStorageListOptions |
onRetrieved | (values, cursor) => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 173
Mobile Only
setValue()
setValue(
key,value,writeOptions,onSaved,onError):void
Sets a value in the persistence backend.
Parameters
| Parameter | Type |
|---|---|
key | string |
value | string | number | boolean | vec2 | vec3 | vec4 | quat | mat3 | mat4 | mat2 |
writeOptions | CloudStorageWriteOptions |
onSaved | () => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 173