Interface RealtimeStoreCreationInfo

Description

Provides extra context about a RealtimeStore's creation.

interface RealtimeStoreCreationInfo {
    allowOwnershipTakeOver: boolean;
    lastUpdatedServerTimestamp: number;
    ownerInfo: UserInfo;
    persistence: Persistence;
    sentServerTimeMilliseconds: number;
    storeId: string;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

allowOwnershipTakeOver lastUpdatedServerTimestamp ownerInfo persistence sentServerTimeMilliseconds storeId

Methods

getTypeName isOfType isSame

Properties

Readonly allowOwnershipTakeOver

allowOwnershipTakeOver: boolean

Description

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

Readonly lastUpdatedServerTimestamp

lastUpdatedServerTimestamp: number

Description

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

Readonly ownerInfo

ownerInfo: UserInfo

Description

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

Readonly persistence

persistence: Persistence

Description

The persistence setting that the store was created with.

Readonly sentServerTimeMilliseconds

sentServerTimeMilliseconds: number

Description

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

Readonly storeId

storeId: string

Description

A string that can be used to identify the RealtimeStore.

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