IContainerRuntimeSignaler interface

Package:

@microsoft/live-share

Duck type of something that provides the expected signalling functionality at the container level.

Remarks

Simplifies the mocks needed to unit test the LiveObjectSynchronizer. Applications can just pass this.context.containerRuntime to any class that takes an IContainerRuntimeSignaler.

Methods

off("signal", (message: IInboundSignalMessage, local: boolean) => void)
on("signal", (message: IInboundSignalMessage, local: boolean) => void)
submitSignal(string, any)

Method Details

off("signal", (message: IInboundSignalMessage, local: boolean) => void)

function off(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): IContainerRuntimeSignaler

Parameters

event

"signal"

listener

(message: IInboundSignalMessage, local: boolean) => void

Returns

IContainerRuntimeSignaler

on("signal", (message: IInboundSignalMessage, local: boolean) => void)

function on(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): IContainerRuntimeSignaler

Parameters

event

"signal"

listener

(message: IInboundSignalMessage, local: boolean) => void

Returns

IContainerRuntimeSignaler

submitSignal(string, any)

function submitSignal(type: string, content: any)

Parameters

type

string

content

any