Interface ConnectionInfo

Information that is bootstrapped to the user who just connected to the session.

interface ConnectionInfo {
    externalUsersInfo: UserInfo[];
    hostUserInfo: UserInfo;
    localUserInfo: UserInfo;
    realtimeStores: GeneralDataStore[];
    realtimeStoresCreationInfos: RealtimeStoreCreationInfo[];
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

externalUsersInfo hostUserInfo localUserInfo realtimeStores realtimeStoresCreationInfos

Methods

getTypeName isOfType isSame

Properties

ReadonlyexternalUsersInfo

externalUsersInfo: UserInfo[]

Get the information about all the other users connected to the same session.

ReadonlyhostUserInfo

hostUserInfo: UserInfo

ReadonlylocalUserInfo

localUserInfo: UserInfo

Get the information about the local user.

ReadonlyrealtimeStores

realtimeStores: GeneralDataStore[]

Get all the Realtime Stores that are being used in the session.

ReadonlyrealtimeStoresCreationInfos

realtimeStoresCreationInfos: RealtimeStoreCreationInfo[]

Provides creation info about every existing RealtimeStore.

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