LocationCloudStorageModule
ClassProvides access to location cloud storage depending upon the LocationCloudStorageOptions.
- Available on all platforms
Since Lens Scripting v182
Index
Properties
Methods
Extends
Properties
name
name:
string
The name of the Asset in Lens Studio.
Default Value
""
Inherited from
session
session:
MultiplayerSession
SPECS
The active session used in the CloudStorageModule.
Since
Lens Scripting Version 182
Default Value
null
@snapOS
uniqueIdentifier
readonlyuniqueIdentifier:string
Since
Lens Scripting Version 176
Inherited from
Methods
getNearbyLocationStores()
getNearbyLocationStores(
options):void
Request discovery of LocationCloudStores based on the user location.
Parameters
| Parameter | Type |
|---|---|
options | LocationCloudStorageOptions |
Returns
void
Since
Lens Scripting Version 182
getTypeName()
staticgetTypeName():TypeName<LocationCloudStorageModule>
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<LocationCloudStorageModule>
Since
Lens Scripting Version 182
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
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
retrieveLocation()
retrieveLocation(
persistedLocationId,onRetrievedLocation,onError):void
Retrieves the specified LocationAsset.
Parameters
| Parameter | Type |
|---|---|
persistedLocationId | string |
onRetrievedLocation | (location) => void |
onError | (error) => void |
Returns
void
Since
Lens Scripting Version 229
storeLocation()
storeLocation(
location,onStoredLocation,onError):void
Stores the specified LocationAsset.
Parameters
| Parameter | Type |
|---|---|
location | LocationAsset |
onStoredLocation | (persistedLocationId) => void |
onError | (error) => void |
Returns
void
Since
Lens Scripting Version 229