Class LocationCloudStorageModule

Provides access to location cloud storage depending upon the LocationCloudStorageOptions.

See

Used By: MappingOptions#locationCloudStorageModule

Hierarchy (View Summary)

Asset
- LocationCloudStorageModule

Index

Properties

name session uniqueIdentifier

Methods

getNearbyLocationStores getTypeName isOfType isSame retrieveLocation storeLocation

Properties

name

name: string

The name of the Asset in Lens Studio.

`Wearable Only`session

session: MultiplayerSession

The active session used in the CloudStorageModule.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

getNearbyLocationStores

getNearbyLocationStores(options: LocationCloudStorageOptions): void
Request discovery of LocationCloudStores based on the user location.
Parameters
- options: LocationCloudStorageOptions
Returns void

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Asset.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame

retrieveLocation

retrieveLocation(
    persistedLocationId: string,
    onRetrievedLocation: (location: LocationAsset) => void,
    onError: (error: string) => void,
): void
Retrieves the specified LocationAsset.
Parameters
- persistedLocationId: string
- onRetrievedLocation: (location: LocationAsset) => void
- onError: (error: string) => void
Returns void

storeLocation

storeLocation(
    location: LocationAsset,
    onStoredLocation: (persistedLocationId: string) => void,
    onError: (error: string) => void,
): void
Stores the specified LocationAsset.
Parameters
- location: LocationAsset
- onStoredLocation: (persistedLocationId: string) => void
- onError: (error: string) => void
Returns void