LocationCloudStore
ClassInstance of location cloud store which has a similar interface as cloud store.
- Available on all platforms
Since Lens Scripting v182
Index
Extends
Methods
deleteValue()
deleteValue(
key,readOptions,onDeleted,onError):void
Deletes a value on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.
Parameters
| Parameter | Type |
|---|---|
key | string |
readOptions | CloudStorageReadOptions |
onDeleted | () => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 182
getTypeName()
staticgetTypeName():TypeName<LocationCloudStore>
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<LocationCloudStore>
Since
Lens Scripting Version 182
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 on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.
Parameters
| Parameter | Type |
|---|---|
key | string |
readOptions | CloudStorageReadOptions |
onRetrieved | (key, value, collection) => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 182
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
List values on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.
Parameters
| Parameter | Type |
|---|---|
listOptions | CloudStorageListOptions |
onRetrieved | (values, cursor, collection) => void |
onError | (code, description) => void |
Returns
void
Since
Lens Scripting Version 182
setValue()
setValue(
key,value,writeOptions,onSaved,onError):void
Create/update a value on the location cloud store. Note: when updating a value, the scope and collection must match that of the original value.
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 182