Channel
Constructors
Constructor
new Channel(
target,
chanId,
__namedParameters): Channel;
RPC communication based on window postMessage
Parameters
| Parameter | Type | Description |
|---|---|---|
target | Window | essentially a window obj we want to send messages to |
chanId | string | Channel id. Allows one frame to contain multiple plugins. |
__namedParameters | { sendOnly?: boolean; } | - |
__namedParameters.sendOnly? | boolean | - |
Returns
Channel
Accessors
targetWindow
Get Signature
get targetWindow(): Window;
Returns
Window
Methods
addEventListener()
addEventListener(listener): void;
Parameters
| Parameter | Type |
|---|---|
listener | ChannelEventListener |
Returns
void
removeEventListener()
removeEventListener(listener): void;
Parameters
| Parameter | Type |
|---|---|
listener | ChannelEventListener |
Returns
void
callRPC()
callRPC<T>(
method,
payload,
transfer?): Promise<RPCCallReply<T>>;
Type Parameters
| Type Parameter |
|---|
T extends keyof RPCCalls |
Parameters
| Parameter | Type |
|---|---|
method | T |
payload | RPCCalls[T]["payload"] |
transfer? | Transferable[] |
Returns
Promise<RPCCallReply<T>>
replyRPC()
replyRPC<T>(event): void;
Type Parameters
| Type Parameter |
|---|
T extends keyof RPCCalls |
Parameters
| Parameter | Type |
|---|---|
event | ChannelRPCReply<T> |
Returns
void
replyRPCError()
replyRPCError(event): void;
Parameters
| Parameter | Type |
|---|---|
event | ChannelRPCErrorReply |
Returns
void
sendEvent()
sendEvent<T>(event): void;
Type Parameters
| Type Parameter |
|---|
T extends keyof EventMessage |
Parameters
| Parameter | Type |
|---|---|
event | ChannelEvent<T> |
Returns
void
unregister()
unregister(): void;
Returns
void