Skip to main content

ConnectedLensModule.RealtimeStoreKeyRemovalInfo

Class

Provides information about a key being removed from a RealtimeStore.

  • 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

key

readonly key: string

Key of the property that was removed.

Since

Lens Scripting Version 181


removerInfo

readonly removerInfo: UserInfo

User that removed the key.

Since

Lens Scripting Version 181


sentServerTimeMilliseconds

readonly sentServerTimeMilliseconds: number

Provides the server timestamp (in milliseconds) of when the key was removed.

Since

Lens Scripting Version 181


store

readonly store: GeneralDataStore

The RealtimeStore that the key was removed from.

Since

Lens Scripting Version 181

Methods

getTypeName()

static getTypeName(): TypeName<RealtimeStoreKeyRemovalInfo>

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

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