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): RealtimeConnection
Constructor
Parameters
- realtime: Realtime
  The realtime API
Returns RealtimeConnection
Overrides Events.constructor
- Defined in submodules/editor-api/src/realtime/connection.js:20

Accessors

authenticated

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

Returns boolean
- Defined in submodules/editor-api/src/realtime/connection.js:237

connected

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

Returns boolean
- Defined in submodules/editor-api/src/realtime/connection.js:228

sharedb

get sharedb(): object
Gets the sharedb instance

Returns object
- Defined in submodules/editor-api/src/realtime/connection.js:246

Methods

connect

connect(url): void
Connect to the realtime server
Parameters
- url: string
  The server URL
Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:39

disconnect

disconnect(): void
Disconnect from the server

Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:77

endBulkSubscribe

endBulkSubscribe(): void
Stop bulk subscribing to documents

Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:127

getDocument

getDocument(collection, id): object
Gets a sharedb document
Parameters
- collection: string
  The collection name
- id: string
  The document id
Returns object
The sharedb document
- Defined in submodules/editor-api/src/realtime/connection.js:113

send

send(data): void
Sends a string to the server
Parameters
- data: string
  The message data
Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:100

sendMessage

sendMessage(name, data): void
Send message to server
Parameters
- name: string
  The message name
- data: object
  The message data
Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:91

startBulkSubscribe

startBulkSubscribe(): void
Start bulk subscribing to documents

Returns void
- Defined in submodules/editor-api/src/realtime/connection.js:120