Search
Preparing search index...
The search index is not available
XJS 3.0 API Reference
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
Remote
Class Remote
Hierarchy
Remote
Index
Constructors
constructor
Properties
client
Id
event
Callbacks
exec
sender
type
Methods
is
Remote
process
Request
receive
Message
send
set
Sender
Object literals
proxy
remote
Constructors
constructor
new
Remote
(
__namedParameters
:
{
clientId
:
string
;
exec
:
ExecFunc
;
type
:
XjsTypes
}
)
:
Remote
Parameters
__namedParameters:
{
clientId
:
string
;
exec
:
ExecFunc
;
type
:
XjsTypes
}
client
Id
:
string
exec
:
ExecFunc
type
:
XjsTypes
Returns
Remote
Properties
client
Id
client
Id
:
string
event
Callbacks
event
Callbacks
:
IEventCallbacks
Private
exec
exec
:
ExecFunc
Private
sender
sender
:
(
...
args
:
unknown
[]
)
=>
void
Type declaration
(
...
args
:
unknown
[]
)
:
void
Parameters
Rest
...
args:
unknown
[]
Returns
void
Private
type
type
:
XjsTypes
Methods
Private
is
Remote
is
Remote
(
)
:
boolean
Returns
boolean
process
Request
process
Request
(
__namedParameters
:
{
args
:
unknown
[]
;
asyncId
:
number
;
clientId
:
string
;
fn
:
string
}
)
:
Promise
<
void
>
Parameters
__namedParameters:
{
args
:
unknown
[]
;
asyncId
:
number
;
clientId
:
string
;
fn
:
string
}
args
:
unknown
[]
async
Id
:
number
client
Id
:
string
fn
:
string
Returns
Promise
<
void
>
receive
Message
receive
Message
(
data
:
string
)
:
void
Parameters
data:
string
Returns
void
send
send
(
message
:
ICreateRequest
)
:
Promise
<
unknown
>
Parameters
message:
ICreateRequest
Returns
Promise
<
unknown
>
set
Sender
set
Sender
(
sender
:
(
...
args
:
unknown
[]
)
=>
void
)
:
void
Parameters
sender:
(
...
args
:
unknown
[]
)
=>
void
(
...
args
:
unknown
[]
)
:
void
Parameters
Rest
...
args:
unknown
[]
Returns
void
Returns
void
Object literals
proxy
proxy
:
object
client
Events
client
Events
:
{}
Type declaration
emit
Event
emit
Event
(
eventName
:
string
, result
:
string
)
:
void
Parameters
eventName:
string
result:
string
Returns
void
get
Client
Events
get
Client
Events
(
clientId
:
ClientId
)
:
unknown
Parameters
clientId:
ClientId
Returns
unknown
register
Event
register
Event
(
clientId
:
ClientId
, eventName
:
string
, sender
:
(
...
args
:
unknown
[]
)
=>
void
)
:
void
Parameters
clientId:
ClientId
eventName:
string
sender:
(
...
args
:
unknown
[]
)
=>
void
(
...
args
:
unknown
[]
)
:
void
Parameters
Rest
...
args:
unknown
[]
Returns
void
Returns
void
unregister
Event
unregister
Event
(
clientId
:
ClientId
, eventName
:
string
)
:
void
Parameters
clientId:
ClientId
eventName:
string
Returns
void
remote
remote
:
object
event
Callbacks
event
Callbacks
:
{}
Type declaration
emit
Event
emit
Event
(
eventName
:
string
, result
:
unknown
)
:
void
Parameters
eventName:
string
result:
unknown
Returns
void
register
Event
register
Event
(
eventName
:
string
, callback
:
(
...
args
:
unknown
[]
)
=>
void
)
:
void
Parameters
eventName:
string
callback:
(
...
args
:
unknown
[]
)
=>
void
(
...
args
:
unknown
[]
)
:
void
Parameters
Rest
...
args:
unknown
[]
Returns
void
Returns
void
unregister
Event
unregister
Event
(
eventName
:
string
)
:
void
Parameters
eventName:
string
Returns
void
Globals
Remote
constructor
client
Id
event
Callbacks
exec
sender
type
is
Remote
process
Request
receive
Message
send
set
Sender
proxy
remote
Generated using
TypeDoc