Share via

IRuntimeSignaler interface

Package:
@microsoft/live-share

Duck type of something that provides the expected signalling functionality: A way to verify we can signal, a way to send a signal, and a way to listen for incoming signals

Properties

clientId
connected
logger

Methods

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

Property Details

clientId 

clientId: undefined | string

Property Value

undefined | string

connected 

connected: boolean

Property Value

boolean

logger 

logger: ITelemetryLogger

Property Value

ITelemetryLogger

Method Details

off("connected", (clientId: string) => void) 

function off(event: "connected", listener: (clientId: string) => void): IRuntimeSignaler

Parameters

event

"connected"

listener

(clientId: string) => void

Returns

IRuntimeSignaler

on("connected", (clientId: string) => void) 

function on(event: "connected", listener: (clientId: string) => void): IRuntimeSignaler

Parameters

event

"connected"

listener

(clientId: string) => void

Returns

IRuntimeSignaler

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

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

Parameters

event

"signal"

listener

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

Returns

IRuntimeSignaler

submitSignal(string, any) 

function submitSignal(type: string, content: any)

Parameters

type

string

content

any