AIDK API Reference / aidk-angular / ChannelsService
Class: ChannelsService ​
Defined in: packages/angular/src/channels.service.ts:17
Implements ​
OnDestroy
Constructors ​
Constructor ​
new ChannelsService(engineService: EngineService): ChannelsService;Defined in: packages/angular/src/channels.service.ts:21
Parameters ​
| Parameter | Type |
|---|---|
engineService | EngineService |
Returns ​
ChannelsService
Methods ​
ngOnDestroy() ​
ngOnDestroy(): void;Defined in: packages/angular/src/channels.service.ts:23
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.
Returns ​
void
Implementation of ​
OnDestroy.ngOnDestroyon() ​
on<T>(channel: string, eventType: string): Observable<T>;Defined in: packages/angular/src/channels.service.ts:61
Subscribe to a specific event type on a channel
Type Parameters ​
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters ​
| Parameter | Type |
|---|---|
channel | string |
eventType | string |
Returns ​
Observable<T>
publish() ​
publish<T>(
channel: string,
type: string,
payload?: unknown): Observable<T>;Defined in: packages/angular/src/channels.service.ts:54
Publish an event to a channel Returns Observable of server response (may include updated state)
Type Parameters ​
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters ​
| Parameter | Type |
|---|---|
channel | string |
type | string |
payload? | unknown |
Returns ​
Observable<T>
subscribe() ​
subscribe(channels: string | string[]): Observable<ChannelEvent>;Defined in: packages/angular/src/channels.service.ts:33
Subscribe to channel events. Returns a shared Observable that multicasts to all subscribers.
Parameters ​
| Parameter | Type |
|---|---|
channels | string | string[] |
Returns ​
Observable<ChannelEvent>