Class RealtimeConnection

Handles connecting and communicating with the Realtime server.

Hierarchy

Events
- RealtimeConnection

Index

Constructors

Accessors

authenticated connected sharedb

Methods

connect disconnect endBulkSubscribe getDocument send sendMessage startBulkSubscribe

Constructors

constructor

new RealtimeConnection(realtime: Realtime): RealtimeConnection
Constructor
Parameters
- realtime: Realtime
  The realtime API
Returns RealtimeConnection
Overrides Events.constructor
- Defined in src/realtime/connection.ts:41

Accessors

authenticated

get authenticated(): boolean
Whether the server has authenticated the user

Returns boolean
- Defined in src/realtime/connection.ts:271

connected

get connected(): boolean
Whether the user is connected to the server

Returns boolean
- Defined in src/realtime/connection.ts:264

sharedb

get sharedb(): any
Gets the sharedb instance

Returns any
- Defined in src/realtime/connection.ts:278

Methods

connect

connect(url: string): void
Connect to the realtime server
Parameters
- url: string
  The server URL
Returns void
- Defined in src/realtime/connection.ts:60

disconnect

disconnect(): void
Disconnect from the server

Returns void
- Defined in src/realtime/connection.ts:115

endBulkSubscribe

endBulkSubscribe(): void
Stop bulk subscribing to documents

Returns void
- Defined in src/realtime/connection.ts:165

getDocument

getDocument(collection: string, id: number): any
Gets a sharedb document
Parameters
- collection: string
  The collection name
- id: number
  The document id
Returns any
The sharedb document
- Defined in src/realtime/connection.ts:151

send

send(data: string): void
Sends a string to the server
Parameters
- data: string
  The message data
Returns void
- Defined in src/realtime/connection.ts:138

sendMessage

sendMessage(name: string, data: object): void
Send message to server
Parameters
- name: string
  The message name
- data: object
  The message data
Returns void
- Defined in src/realtime/connection.ts:129

startBulkSubscribe

startBulkSubscribe(): void
Start bulk subscribing to documents

Returns void
- Defined in src/realtime/connection.ts:158