RealtimeCommunicator | EVA SDK Redux

The realtime communicator handles the SignalR hubs and their connections

export

Hierarchy

RealtimeCommunicator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RealtimeCommunicator(): RealtimeCommunicator

- Defined in src/communicator/hubs.ts:303
Creates an instance of RealtimeCommunicator The realtime communicator uses SignalR to connect to a number of hubs supplied by EVA. The getApplicationConfiguration response will contain the required urls

memberof

RealtimeCommunicator

Returns RealtimeCommunicator

Properties

activity$

activity$: Subject<IConnectionActivity>

Debug-able activity stream for SignalR

connection

connection: {}

All the connection grouped by hub

memberof: RealtimeCommunicator

Type declaration

[hubName: string]: IHubConnection[]

event$

event$: Subject<IHubEvent>

The combined realtime event feed from all hubs as an observable

memberof: RealtimeCommunicator

Private hubs

hubs: IEvaSignalRHub[] = []

The current list of EVA SignalR hubs

memberof: RealtimeCommunicator

peers$

peers$: Observable<IPeerClientStatus[]> = this._peers$.asObservable()

Methods

Protected buildHeaders

buildHeaders(joinRequest: IHubJoinRequestBase): MessageHeaders

- Defined in src/communicator/hubs.ts:401
Helper method to build signalr connection headers

Parameters
- joinRequest: IHubJoinRequestBase
Returns MessageHeaders

Protected buildQueryParams

buildQueryParams(joinRequest: IHubJoinRequestBase): string[]

- Defined in src/communicator/hubs.ts:444
Helper method to build signalr connection query parameters

Parameters
- joinRequest: IHubJoinRequestBase
Returns string[]

disconnectAll

disconnectAll(): Promise<void>

- Defined in src/communicator/hubs.ts:479
Disconnect all existing hub connections

memberof

RealtimeCommunicator

Returns Promise<void>

getChannelStatus

getChannelStatus(channelName: string): undefined | IChannelStatus

- Defined in src/communicator/hubs.ts:2221
Retrieves the connected clients for a specific channel

Parameters
- channelName: string
Returns undefined | IChannelStatus

IChannelStatus

getChannels

getChannels(): string[]

- Defined in src/communicator/hubs.ts:2201
Retrieves the names of the currently connected channels

Returns string[]

{string[]}

getPeers

getPeers(): IPeerClientStatus[]

- Defined in src/communicator/hubs.ts:2211
Retrieves the list of all other clients currently connected to the client app hub.

Returns IPeerClientStatus[]

{IPeerClientStatus[]}

joinChannel

joinChannel(joinRequest: IHubEventJoinedChannelMessage, hubName?: string): Promise<undefined | void[]>

- Defined in src/communicator/hubs.ts:2703
Join a channel on a client app hub connection

Parameters
- joinRequest: IHubEventJoinedChannelMessage
- Default value hubName: string = "ClientAppHub"
Returns Promise<undefined | void[]>

joinClientAppHub

joinClientAppHub(subscription: IHubClientAppJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:2252
Start listening to updates from the client app hub

Parameters
- subscription: IHubClientAppJoinRequest
Returns Promise<IHubConnection>

joinCustomerFacingDisplayHub

joinCustomerFacingDisplayHub(subscription: IHubCustomerFacingDisplayJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:1427
Start listening to CFD hub events You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubCustomerFacingDisplayJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinDeviceHub

joinDeviceHub(subscription: IHubDeviceJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:511
Start listening to device hub events for a specific device You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubDeviceJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinElevationBarcodeHub

joinElevationBarcodeHub(subscription: IHubElevationBarcodeJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:3431
Start listening to elevation barcode hub events for a specific RequestToken You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubElevationBarcodeJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinGlobalBlueHub

joinGlobalBlueHub(subscription: IHubGlobalBlueJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:2964
Start listening to Global Blue hub events for a group identifier You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubGlobalBlueJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinMagicLinkHub

joinMagicLinkHub(subscription: IHubMagicLinkJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:3232
Start listening to magic link hub events for a specific RequestToken You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubMagicLinkJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinOrderHub

joinOrderHub(subscription: IHubOrderJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:891
Start listening to order hub events for a specific order You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubOrderJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

joinPaymentHub

joinPaymentHub(subscription: IHubPaymentJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:1758
Start listening to updates for a payment transaction

Parameters
- subscription: IHubPaymentJoinRequest
Returns Promise<IHubConnection>

joinUserTaskHub

joinUserTaskHub(subscription: IHubUserTaskJoinRequest): Promise<IHubConnection>

- Defined in src/communicator/hubs.ts:1208
Start listening to user task hub events You can either supply a callback(s) here or listen to the event$ observable

memberof

RealtimeCommunicator

Parameters
- subscription: IHubUserTaskJoinRequest
  
  The subscription details
Returns Promise<IHubConnection>

leaveChannel

leaveChannel(leaveRequest: IHubEventLeftChannelMessage, hubName?: string): Promise<undefined | void[]>

- Defined in src/communicator/hubs.ts:2743
Leave a channel on a client app hub connection

Parameters
- leaveRequest: IHubEventLeftChannelMessage
- Default value hubName: string = "ClientAppHub"
Returns Promise<undefined | void[]>

leaveClientAppHub

leaveClientAppHub(subscription: IHubClientAppJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:2633
Stop listening to client app update events

Parameters
- subscription: IHubClientAppJoinRequest
Returns Promise<void>

leaveCustomerFacingDisplayHub

leaveCustomerFacingDisplayHub(subscription: IHubCustomerFacingDisplayJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:1660
Stop listening to CFD hub events for a specific device

memberof

RealtimeCommunicator

Parameters
- subscription: IHubCustomerFacingDisplayJoinRequest
Returns Promise<void>

leaveDeviceHub

leaveDeviceHub(subscription: IHubDeviceJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:768
Stop listening to device hub events for a specific device

memberof

RealtimeCommunicator

Parameters
- subscription: IHubDeviceJoinRequest
Returns Promise<void>

leaveElevationBarcodeHub

leaveElevationBarcodeHub(subscription: IHubElevationBarcodeJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:3589
Stop listening to elevation barcode hub events

memberof

RealtimeCommunicator

Parameters
- subscription: IHubElevationBarcodeJoinRequest
  
  The subscription details
Returns Promise<void>

leaveGlobalBlueHub

leaveGlobalBlueHub(subscription: IHubGlobalBlueJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:3187
Stop listening to Global Blue hub events

Parameters
- subscription: IHubGlobalBlueJoinRequest
  
  The original join request which we need for the group id
Returns Promise<void>

leaveMagicLinkHub

leaveMagicLinkHub(subscription: IHubMagicLinkJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:3390
Stop listening to magic link hub events

memberof

RealtimeCommunicator

Parameters
- subscription: IHubMagicLinkJoinRequest
  
  The subscription details
Returns Promise<void>

leaveOrderHub

leaveOrderHub(subscription: IHubOrderJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:1149
Stop listening to order hub events for a specific order

memberof

RealtimeCommunicator

Parameters
- subscription: IHubOrderJoinRequest
  
  The subscription details
Returns Promise<void>

leavePaymentHub

leavePaymentHub(subscription: IHubPaymentJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:1991
Stop listening to payment transaction update events

Parameters
- subscription: IHubPaymentJoinRequest
Returns Promise<void>

leaveUserTaskHub

leaveUserTaskHub(subscription: IHubUserTaskJoinRequest): Promise<void>

- Defined in src/communicator/hubs.ts:1377
Stop listening to user task hub events for a specific device

memberof

RealtimeCommunicator

Parameters
- subscription: IHubUserTaskJoinRequest
Returns Promise<void>

ping

ping(uuid: string): Promise<void[]>

- Defined in src/communicator/hubs.ts:2822
Manually triggers a ping to see which other clients are currently connected to the hub

Parameters
- uuid: string
Returns Promise<void[]>

purgeStalePeers

purgeStalePeers(): void

- Defined in src/communicator/hubs.ts:2178
Removes all clients from the peers list that haven't been seen in a while

Returns void

pushDisplayOrderToDevice

pushDisplayOrderToDevice(updateDisplayOrderEvent: IHubPushDisplayOrderToDeviceID, hubName?: string): Promise<void[]>

- Defined in src/communicator/hubs.ts:1723
Push an update for the displayed order to the customer facing display

memberof

RealtimeCommunicator

Parameters
- updateDisplayOrderEvent: IHubPushDisplayOrderToDeviceID
- Default value hubName: string = "CustomerFacingDisplayHub"
Returns Promise<void[]>

reconnect

reconnect(hubName?: string): Promise<undefined | void[]>

- Defined in src/communicator/hubs.ts:2935
Force an immediate reconnection attempt. Can be useful for clients coming out of a sleep or apps being resumed. ClientApp hub is usually the one you want to immediately reconnect to

Parameters
- Default value hubName: string = "ClientAppHub"
Returns Promise<undefined | void[]>

sendAppMessage

sendAppMessage(appMessage: IClientAppMessage, hubName?: string): Promise<void[]>

- Defined in src/communicator/hubs.ts:2785
Push a message to all apps registered on the same hub

memberof

RealtimeCommunicator

Parameters
- appMessage: IClientAppMessage
- Default value hubName: string = "ClientAppHub"
Returns Promise<void[]>

sendScannedBarcode

sendScannedBarcode(scanEvent: IHubEventBarcode, hubName?: string): Promise<void>

- Defined in src/communicator/hubs.ts:824
Send a scanned barcode to a device hub

memberof

RealtimeCommunicator

Parameters
- scanEvent: IHubEventBarcode
- Default value hubName: string = "DeviceHub"
Returns Promise<void>

sendSessionToDevice

sendSessionToDevice(transferSessionEvent: IHubPushSessionToDeviceID, hubName?: string): Promise<void>

- Defined in src/communicator/hubs.ts:856
Transfers a session to another device

memberof

RealtimeCommunicator

Parameters
- transferSessionEvent: IHubPushSessionToDeviceID
- Default value hubName: string = "DeviceHub"
Returns Promise<void>

start

start(): Promise<void>

- Defined in src/communicator/hubs.ts:329
Start listening to the getApplicationConfig Will resolve its promise when first application config is received

memberof

RealtimeCommunicator

Returns Promise<void>

stop

stop(): Promise<void>

- Defined in src/communicator/hubs.ts:376
Stop listening for application configuration changes and disconnect all hubs

memberof

RealtimeCommunicator

Returns Promise<void>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RealtimeCommunicator

Properties

activity$

connection

Type declaration

[hubName: string]: IHubConnection[]

event$

Private hubs

peers$

Methods

Protected buildHeaders

Parameters

joinRequest: IHubJoinRequestBase

Returns MessageHeaders

Protected buildQueryParams

Parameters

joinRequest: IHubJoinRequestBase

Returns string[]

disconnectAll

Returns Promise<void>

getChannelStatus

Parameters

channelName: string

Returns undefined | IChannelStatus

getChannels

Returns string[]

getPeers

Returns IPeerClientStatus[]

joinChannel

Parameters

joinRequest: IHubEventJoinedChannelMessage

Default value hubName: string = "ClientAppHub"

Returns Promise<undefined | void[]>

joinClientAppHub

Parameters

subscription: IHubClientAppJoinRequest

Returns Promise<IHubConnection>

joinCustomerFacingDisplayHub

Parameters

subscription: IHubCustomerFacingDisplayJoinRequest

Returns Promise<IHubConnection>

joinDeviceHub

Parameters

subscription: IHubDeviceJoinRequest

Returns Promise<IHubConnection>

joinElevationBarcodeHub

Parameters

subscription: IHubElevationBarcodeJoinRequest

Returns Promise<IHubConnection>

joinGlobalBlueHub

Parameters

subscription: IHubGlobalBlueJoinRequest

Returns Promise<IHubConnection>

joinMagicLinkHub

Parameters

subscription: IHubMagicLinkJoinRequest

Returns Promise<IHubConnection>

joinOrderHub

Parameters

subscription: IHubOrderJoinRequest

Returns Promise<IHubConnection>

joinPaymentHub

Parameters

subscription: IHubPaymentJoinRequest

Returns Promise<IHubConnection>

joinUserTaskHub

Parameters

subscription: IHubUserTaskJoinRequest

Returns Promise<IHubConnection>

leaveChannel

Parameters

leaveRequest: IHubEventLeftChannelMessage

Default value hubName: string = "ClientAppHub"