Constructors
constructor
- new Realtime(client: IFetchClient, url?: string, handshakeCallback?: any): Realtime
-
Parameters
-
-
url: string = '/notification/realtime'
-
Optional
handshakeCallback: any
Methods
addConnectListener
- addConnectListener(callback: ((msg: Message) => void)): SubscriptionHandle
-
Parameters
-
callback: ((msg: Message) => void)
-
- (msg: Message): void
-
Returns void
Returns SubscriptionHandle
addHandshakeListener
- addHandshakeListener(callback: ((msg: HandshakeMessage) => void)): SubscriptionHandle
-
Parameters
-
callback: ((msg: HandshakeMessage) => void)
-
- (msg: HandshakeMessage): void
-
Returns void
Returns SubscriptionHandle
disconnect
- disconnect(disconnectCallback?: Listener): void
-
Parameters
-
disconnectCallback: Listener = undefined
Returns void
isDisconnected
- isDisconnected(): boolean
-
Returns boolean
removeListener
- removeListener(subscriptionHandle: SubscriptionHandle): void
-
Parameters
-
subscriptionHandle: SubscriptionHandle
Returns void
resubscribe
- resubscribe(subscriptionHandle: SubscriptionHandle): SubscriptionHandle
-
Parameters
-
subscriptionHandle: SubscriptionHandle
Returns SubscriptionHandle
subscribe
- subscribe(channel: string, callback: Callback): SubscriptionHandle
-
Parameters
-
channel: string
-
callback: Callback
Returns SubscriptionHandle
unsubscribe
- unsubscribe(subscription: SubscriptionHandle): void
-
Parameters
-
subscription: SubscriptionHandle
Returns void
Allows to set up a realtime (websocket or long-polling) connection to the platform.