Class HarmonyHub

The main class for managing a harmony hub

Hierarchy

HarmonyHub

Implements

SubscriptionLike

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new HarmonyHub(url: string, keepAlive?: number, _clientFactory?: HarmonyClientFactory): HarmonyHub

- Defined in harmony-hub.class.ts:176
Parameters
- url: string
- Default value keepAlive: number = 5
- Default value _clientFactory: HarmonyClientFactory = createHarmonyClient
Returns HarmonyHub

Properties

Protected _activities

_activities: Map<string, IHarmonyActivity> = new Map()

Protected _client$

_client$: Observable<IHarmonyClient>

Protected _clientFactory

_clientFactory: HarmonyClientFactory

Protected _config

_config: IHarmonyConfig

Protected _currentActivity

_currentActivity: IHarmonyActivity

Protected _keepAliveSubscription

_keepAliveSubscription: Subscription

Protected _stopClient

_stopClient: function

Type declaration

- (): void
- Returns void

url

url: string

Accessors

closed

get closed(): boolean

- Defined in harmony-hub.class.ts:170
Returns boolean

Protected config

set config(conf: IHarmonyConfig): void

- Defined in harmony-hub.class.ts:160
Parameters
- conf: IHarmonyConfig
Returns void

Methods

getConfig

getConfig(): Promise<IHarmonyConfig>

- Defined in harmony-hub.class.ts:255
Returns Promise<IHarmonyConfig>

getCurrentActivity

getCurrentActivity(): Promise<IHarmonyActivity>

- Defined in harmony-hub.class.ts:269
Returns Promise<IHarmonyActivity>

getLabel

getLabel(activityId: string): string

- Defined in harmony-hub.class.ts:225
Parameters
- activityId: string
Returns string

observe

observe(): Observable<IHubEvent>

- Defined in harmony-hub.class.ts:230
Returns Observable<IHubEvent>

press

press(key: string, durationInMs?: number): Promise<any>

- Defined in harmony-hub.class.ts:335
Parameters
- key: string
- Default value durationInMs: number = 50
Returns Promise<any>

request

request(command: string, body?: IHarmonyRequest): Promise<any>

- Defined in harmony-hub.class.ts:300
Parameters
- command: string
- Optional body: IHarmonyRequest
Returns Promise<any>

resolveActivity

resolveActivity(idOrLabel: string): IHarmonyActivity

- Defined in harmony-hub.class.ts:221
Parameters
- idOrLabel: string
Returns IHarmonyActivity

send

send(command: string, body?: IHarmonyRequest): Promise<any>

- Defined in harmony-hub.class.ts:288
Parameters
- command: string
- Optional body: IHarmonyRequest
Returns Promise<any>

startActivity

startActivity(activityId: string): Promise<any>

- Defined in harmony-hub.class.ts:278
Parameters
- activityId: string
Returns Promise<any>

unsubscribe

unsubscribe(): void

- Defined in harmony-hub.class.ts:379
Returns void

Static create

create(ip: string): HarmonyHub

- Defined in harmony-hub.class.ts:174
Parameters
- ip: string
Returns HarmonyHub

Generated using TypeDoc