Skip to main content

ConnectedLensModule.RealtimeStoreCreationInfo

Class

Provides extra context about a RealtimeStore's creation.

  • 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.

Index

Extends

Properties

allowOwnershipTakeOver

readonly allowOwnershipTakeOver: boolean

If true, ownership of the store can be claimed even if the store is already owned.

Since

Lens Scripting Version 184


lastUpdatedServerTimestamp

readonly lastUpdatedServerTimestamp: number

Provides the server timestamp (in milliseconds) of the last time the store was updated.

Since

Lens Scripting Version 181


ownerInfo

readonly ownerInfo: UserInfo

Provides the UserInfo of the current owner of the RealtimeStore. If the store is unowned, a UserInfo object with null fields will be returned.

Since

Lens Scripting Version 181


persistence

readonly persistence: Persistence

The persistence setting that the store was created with.

Since

Lens Scripting Version 173


sentServerTimeMilliseconds

readonly sentServerTimeMilliseconds: number

Provides the server timestamp (in milliseconds) of when the store was created.

Since

Lens Scripting Version 181


storeId

readonly storeId: string

A string that can be used to identify the RealtimeStore.

Since

Lens Scripting Version 181

Methods

getTypeName()

static getTypeName(): TypeName<RealtimeStoreCreationInfo>

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

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