Class ConnectionInfo

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

Hierarchy (View Summary, Expand)

ScriptObject
- ConnectionInfo

Index

Constructors

Properties

externalUsersInfo hostUserInfo localUserInfo realtimeStores realtimeStoresCreationInfos

Methods

getTypeName isOfType isSame

Constructors

`Protected`constructor

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

Properties

`Readonly`externalUsersInfo

externalUsersInfo: UserInfo[]

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

`Readonly`hostUserInfo

hostUserInfo: UserInfo

`Readonly`localUserInfo

localUserInfo: UserInfo

Get the information about the local user.

`Readonly`realtimeStores

realtimeStores: GeneralDataStore[]

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

`Readonly`realtimeStoresCreationInfos

realtimeStoresCreationInfos: RealtimeStoreCreationInfo[]

Provides creation info about every existing RealtimeStore.

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