Skip to main content

LocationCloudStorageOptions

Class

Used to configure LocationCloudStorage module with various options.

  • 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

Properties

collection

collection: string

Tag to represent a collection of objects/entities

Since

Lens Scripting Version 182

Default Value

""

location

location: LocationAsset

Provides a frame of reference in which to localize objects to the real world. Could be any location type.

Since

Lens Scripting Version 182

Default Value

null

onDiscoveredNearby

readonly onDiscoveredNearby: event2<LocationAsset, LocationCloudStore, void>

Event raised on discovery of nearby cloud stores.

Since

Lens Scripting Version 182


onError

readonly onError: event3<LocationAsset, string, string, void>

Error event raised when failing to instantiate a location cloud store associated with that location asset.

Since

Lens Scripting Version 182

Methods

create()

static create(): LocationCloudStorageOptions

Create options to provide to LocationCloudStorageModule

Returns

LocationCloudStorageOptions

Since

Lens Scripting Version 182


getTypeName()

static getTypeName(): TypeName<LocationCloudStorageOptions>

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<LocationCloudStorageOptions>

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


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