Interface LocationCloudStorageModule

Provides access to location cloud storage depending upon the LocationCloudStorageOptions.

Example

​
interface LocationCloudStorageModule {
    name: string;
    uniqueIdentifier: string;
    getNearbyLocationStores(options: LocationCloudStorageOptions): void;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    retrieveLocation(persistedLocationId: string, onRetrievedLocation: ((location: LocationAsset) => void), onError: ((error: string) => void)): void;
    storeLocation(location: LocationAsset, onStoredLocation: ((persistedLocationId: string) => void), onError: ((error: string) => void)): void;
}

Hierarchy (view full)

  • Asset
    • LocationCloudStorageModule

Properties

name uniqueIdentifier

Methods

getNearbyLocationStores getTypeName isOfType isSame retrieveLocation storeLocation

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

getNearbyLocationStores

  • getNearbyLocationStores(options): void

  • Request discovery of LocationCloudStores based on the user location.

    Parameters

    Returns void

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

retrieveLocation

  • retrieveLocation(persistedLocationId, onRetrievedLocation, onError): void

  • Retrieves the specified LocationAsset.

    Parameters

    • persistedLocationId: string
    • onRetrievedLocation: ((location: LocationAsset) => void)
    • onError: ((error: string) => void)
        • (error): void

        • Parameters

          • error: string

          Returns void

    Returns void

storeLocation

  • storeLocation(location, onStoredLocation, onError): void

  • Stores the specified LocationAsset.

    Parameters

    • location: LocationAsset
    • onStoredLocation: ((persistedLocationId: string) => void)
        • (persistedLocationId): void

        • Parameters

          • persistedLocationId: string

          Returns void

    • onError: ((error: string) => void)
        • (error): void

        • Parameters

          • error: string

          Returns void

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods