Interface RealtimeStoreKeyRemovalInfo

Description

Provides information about a key being removed from a RealtimeStore.

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

Hierarchy (view full)

Properties

key removerInfo sentServerTimeMilliseconds store

Methods

getTypeName isOfType isSame

Properties

Readonly key

key: string

Description

Key of the property that was removed.

Readonly removerInfo

removerInfo: UserInfo

Description

User that removed the key.

Readonly sentServerTimeMilliseconds

sentServerTimeMilliseconds: number

Description

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

Readonly store

store: GeneralDataStore

Description

The RealtimeStore that the key was removed from.

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc