Skip to main content

CloudStorageOptions

Class

Used to configure Cloud Storage 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 v173

Used to configure Cloud Storage Module with various options. Note: if session scoped storage is required, this option must be provided.

Not available on SPECS. Use Snap Cloud for persistence there instead.

Index

Mobile Only

Extends

Properties

session

session: MultiplayerSession

If session scoped storage is required, set this property with the session object from ConnectedLensModule.

Since

Lens Scripting Version 173

Default Value

null

Mobile Only

Methods

create()

static create(): CloudStorageOptions

Create options for use with Cloud Storage.

Returns

CloudStorageOptions

Since

Lens Scripting Version 173

Mobile Only


getTypeName()

static getTypeName(): TypeName<CloudStorageOptions>

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

Since

Lens Scripting Version 173

Mobile Only

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