Skip to main content

LocationCloudStore

Class

Instance of location cloud store which has a similar interface as cloud store.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

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

ParameterType
keystring
readOptionsCloudStorageReadOptions
onDeleted() => void
onError(code, description) => void

Returns

void

Since

Lens Scripting Version 182


getTypeName()

static getTypeName(): 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

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


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

ParameterType
keystring
readOptionsCloudStorageReadOptions
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

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame


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

ParameterType
listOptionsCloudStorageListOptions
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

ParameterType
keystring
valuestring | number | boolean | vec2 | vec3 | vec4 | quat | mat3 | mat4 | mat2
writeOptionsCloudStorageWriteOptions
onSaved() => void
onError(code, description) => void

Returns

void

Since

Lens Scripting Version 182