Class RealtimeStoreKeyRemovalInfo

Provides information about a key being removed from a RealtimeStore.

Hierarchy (View Summary, Expand)

ScriptObject
- RealtimeStoreKeyRemovalInfo

Index

Constructors

Properties

key removerInfo sentServerTimeMilliseconds store

Methods

getTypeName isOfType isSame

Constructors

`Protected`constructor

new RealtimeStoreKeyRemovalInfo(): RealtimeStoreKeyRemovalInfo
Returns RealtimeStoreKeyRemovalInfo
Overrides ScriptObject.constructor

Properties

`Readonly`key

key: string

Key of the property that was removed.

`Readonly`removerInfo

removerInfo: UserInfo

User that removed the key.

`Readonly`sentServerTimeMilliseconds

sentServerTimeMilliseconds: number

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

`Readonly`store

store: GeneralDataStore

The RealtimeStore that the key was removed from.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from ScriptObject.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from ScriptObject.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from ScriptObject.isSame