SignalClient
Defined in: seyd/sdks/js/core/src/signal.ts:19
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SignalClient(
url,token?):SignalClient
Defined in: seyd/sdks/js/core/src/signal.ts:26
Parameters
Section titled “Parameters”string
token?
Section titled “token?”string
Returns
Section titled “Returns”SignalClient
Properties
Section titled “Properties”subject
Section titled “subject”subject:
string|null=null
Defined in: seyd/sdks/js/core/src/signal.ts:24
readonlyurl:string
Defined in: seyd/sdks/js/core/src/signal.ts:26
Accessors
Section titled “Accessors”isOpen
Section titled “isOpen”Get Signature
Section titled “Get Signature”get isOpen():
boolean
Defined in: seyd/sdks/js/core/src/signal.ts:73
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”abort()
Section titled “abort()”abort(
sessionId):boolean
Defined in: seyd/sdks/js/core/src/signal.ts:85
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
Returns
Section titled “Returns”boolean
close()
Section titled “close()”close():
void
Defined in: seyd/sdks/js/core/src/signal.ts:90
Returns
Section titled “Returns”void
connect()
Section titled “connect()”connect():
void
Defined in: seyd/sdks/js/core/src/signal.ts:39
Returns
Section titled “Returns”void
connectRobot()
Section titled “connectRobot()”connectRobot(
robotId):boolean
Defined in: seyd/sdks/js/core/src/signal.ts:81
Parameters
Section titled “Parameters”robotId
Section titled “robotId”string
Returns
Section titled “Returns”boolean
on<
K>(type,h): () =>void
Defined in: seyd/sdks/js/core/src/signal.ts:28
Type Parameters
Section titled “Type Parameters”K extends keyof SignalEvents
Parameters
Section titled “Parameters”K
Handler<SignalEvents[K]>
Returns
Section titled “Returns”() => void
report()
Section titled “report()”report(
sessionId,outcome,extra?):boolean
Defined in: seyd/sdks/js/core/src/signal.ts:86
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
outcome
Section titled “outcome”"p2p" | "relay" | "failed"
extra?
Section titled “extra?”Record<string, unknown> = {}
Returns
Section titled “Returns”boolean
retry()
Section titled “retry()”retry(
sessionId):boolean
Defined in: seyd/sdks/js/core/src/signal.ts:84
Parameters
Section titled “Parameters”sessionId
Section titled “sessionId”string
Returns
Section titled “Returns”boolean
send()
Section titled “send()”send(
msg):boolean
Defined in: seyd/sdks/js/core/src/signal.ts:75
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”boolean