Class ApiClient

Hierarchy

ApiClient

Implements

UhstRelayClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ApiClient(relayClientProvider: RelayClientProvider, relayUrlsProvider?: RelayUrlsProvider): ApiClient

- Defined in lib/ApiClient.ts:15
Parameters
- relayClientProvider: RelayClientProvider
- Optional relayUrlsProvider: RelayUrlsProvider
Returns ApiClient

Properties

relayClient

relayClient: RelayClient

Private relayClientProvider

relayClientProvider: RelayClientProvider

relayUrlsProvider

relayUrlsProvider: RelayUrlsProvider

Methods

initClient

initClient(hostId: string): Promise<ClientConfiguration>

Implementation of UhstRelayClient.initClient
- Defined in lib/ApiClient.ts:43
Parameters
- hostId: string
Returns Promise<ClientConfiguration>

initHost

initHost(hostId?: undefined | string): Promise<HostConfiguration>

Implementation of UhstRelayClient.initHost
- Defined in lib/ApiClient.ts:23
Parameters
- Optional hostId: undefined | string
Returns Promise<HostConfiguration>

sendMessage

sendMessage(token: string, message: any, sendUrl?: undefined | string): Promise<any>

Implementation of UhstRelayClient.sendMessage
- Defined in lib/ApiClient.ts:69
Parameters
- token: string
- message: any
- Optional sendUrl: undefined | string
Returns Promise<any>

subscribeToMessages

subscribeToMessages(token: string, messageHandler: MessageHandler, relayErrorHandler: Function, relayEventHandler: RelayEventHandler, receiveUrl?: undefined | string): Promise<MessageStream>

- Defined in lib/ApiClient.ts:73
Parameters
- token: string
- messageHandler: MessageHandler
- relayErrorHandler: Function
- relayEventHandler: RelayEventHandler
- Optional receiveUrl: undefined | string
Returns Promise<MessageStream>

Generated using TypeDoc