Search
Preparing search index...
The search index is not available
Mixed Reality Extension SDK
Options
All
Public
Public/Protected
All
Inherited
Menu
Globals
ClientStartup
Class ClientStartup
Hierarchy
Protocol
ClientStartup
Index
Constructors
constructor
Properties
default
Max
Listeners
Accessors
conn
name
promises
Methods
add
Listener
completed
drain
Promises
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
recv
Message
recv
Payload
remove
All
Listeners
remove
Listener
run
send
Message
send
Payload
set
Max
Listeners
start
Listening
stop
Listening
use
listener
Count
Constructors
constructor
new
Client
Startup
(
client
:
Client
, syncRequest
:
Payloads.SyncRequest
)
:
ClientStartup
Parameters
client:
Client
syncRequest:
Payloads.SyncRequest
Returns
ClientStartup
Properties
Static
default
Max
Listeners
default
Max
Listeners
:
number
Accessors
conn
get
conn
(
)
:
Connection
Returns
Connection
name
get
name
(
)
:
string
override
Returns
string
promises
get
promises
(
)
:
Map
<
Guid
,
QueuedPromise
>
Returns
Map
<
Guid
,
QueuedPromise
>
Methods
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
completed
completed
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
drain
Promises
drain
Promises
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
off
off
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
on
on
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
once
once
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
recv
Message
recv
Message
(
message
:
Message
)
:
void
Parameters
message:
Message
Returns
void
recv
Payload
recv
Payload
(
payload
:
Partial
<
Payloads.Payload
>
)
:
void
Parameters
payload:
Partial
<
Payloads.Payload
>
Returns
void
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
(
...
args
:
any
[]
)
=>
void
)
:
this
Parameters
event:
string
|
symbol
listener:
(
...
args
:
any
[]
)
=>
void
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
run
run
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
send
Message
send
Message
(
message
:
Message
, promise
?:
ExportedPromise
, timeoutSeconds
?:
number
)
:
void
override
Parameters
message:
Message
Optional
promise:
ExportedPromise
Optional
timeoutSeconds:
number
Returns
void
send
Payload
send
Payload
(
payload
:
Partial
<
Payloads.Payload
>
, promise
?:
ExportedPromise
)
:
void
Parameters
payload:
Partial
<
Payloads.Payload
>
Optional
promise:
ExportedPromise
Returns
void
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
start
Listening
start
Listening
(
)
:
void
Returns
void
stop
Listening
stop
Listening
(
)
:
void
Returns
void
use
use
(
middleware
:
Middleware
)
:
void
Parameters
middleware:
Middleware
Returns
void
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
Client
Startup
constructor
default
Max
Listeners
conn
name
promises
add
Listener
completed
drain
Promises
emit
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
prepend
Listener
prepend
Once
Listener
raw
Listeners
recv
Message
recv
Payload
remove
All
Listeners
remove
Listener
run
send
Message
send
Payload
set
Max
Listeners
start
Listening
stop
Listening
use
listener
Count