Interface Channel<T>
interface Channel<T> {
binary: boolean;
id: null | string;
options: JsonObject;
ready: boolean;
valid: boolean;
addEventListener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void;
close(options?: JsonObject): void;
control(options: ControlMessage): void;
dispatchEvent<E extends keyof ChannelEvents<T>>(event: E, ...args: Parameters<ChannelEvents<T>[E]>): void;
removeEventListener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void;
send(data: T): void;
wait(): Promise<void>;
}
binary: boolean;
id: null | string;
options: JsonObject;
ready: boolean;
valid: boolean;
addEventListener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void;
close(options?: JsonObject): void;
control(options: ControlMessage): void;
dispatchEvent<E extends keyof ChannelEvents<T>>(event: E, ...args: Parameters<ChannelEvents<T>[E]>): void;
removeEventListener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void;
send(data: T): void;
wait(): Promise<void>;
}
Type Parameters
Hierarchy-Diagram
Legend
interface
public property
public method
Hierarchy (view full)
- EventSource<ChannelEvents<T>>
- Channel
Index
Properties
Methods
Properties
binary
binary: boolean
id
id: null | string
options
ready
ready: boolean
valid
valid: boolean
Methods
add
- add
Event Listener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void Type Parameters
- E extends keyof ChannelEvents<T>
Parameters
- event: E
- listener: cockpit.EventListener<ChannelEvents<T>[E]>
Returns void
close
- close(options?: JsonObject): void
Parameters
Optionaloptions: JsonObject
Returns void
control
- control(options: ControlMessage): void
Parameters
- options: ControlMessage
Returns void
dispatch
- dispatch
Event<E extends keyof ChannelEvents<T>>(event: E, ...args: Parameters<ChannelEvents<T>[E]>): void Type Parameters
- E extends keyof ChannelEvents<T>
Parameters
- event: E
Rest...args: Parameters<ChannelEvents<T>[E]>
Returns void
remove
- remove
Event Listener<E extends keyof ChannelEvents<T>>(event: E, listener: cockpit.EventListener<ChannelEvents<T>[E]>): void Type Parameters
- E extends keyof ChannelEvents<T>
Parameters
- event: E
- listener: cockpit.EventListener<ChannelEvents<T>[E]>
Returns void