Interface RealtimeStoreKeyRemovalInfo

Provides information about a key being removed from a RealtimeStore.

interface RealtimeStoreKeyRemovalInfo {
    key: string;
    removerInfo: UserInfo;
    sentServerTimeMilliseconds: number;
    store: GeneralDataStore;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

key removerInfo sentServerTimeMilliseconds store

Methods

getTypeName isOfType isSame

Properties

Readonlykey

key: string

Key of the property that was removed.

ReadonlyremoverInfo

removerInfo: UserInfo

User that removed the key.

ReadonlysentServerTimeMilliseconds

sentServerTimeMilliseconds: number

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

Readonlystore

store: GeneralDataStore

The RealtimeStore that the key was removed from.

Methods

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods