BIM.works SDKs - v1.5.0-b164
Preparing search index...
@sascom/jsclient
Task
Class Task
Index
Constructors
constructor
Properties
id
node
Id
request
task
Name
Methods
add
Stream
details
Update
error
exec
exec
As
Promise
log
metric
Definition
Update
metric
Update
new
Binary
Data
new
Data
progress
send
set
Node
Id
set
Time
Out
status
Change
success
task
Info
terminate
Constructors
constructor
new
Task
()
:
Task
Returns
Task
Properties
Readonly
id
id
:
string
Readonly
node
Id
nodeId
:
unknown
Readonly
request
request
:
unknown
Readonly
task
Name
taskName
:
string
Methods
add
Stream
addStream
(
name
:
string
,
file
:
unknown
)
:
void
Parameters
name
:
string
file
:
unknown
Returns
void
details
Update
detailsUpdate
(
detailsUpdateCallback
:
(
details
:
unknown
)
=>
void
)
:
Task
Parameters
detailsUpdateCallback
:
(
details
:
unknown
)
=>
void
Returns
Task
error
error
(
errorCallback
:
(
error
:
unknown
,
response
:
unknown
)
=>
void
)
:
Task
Parameters
errorCallback
:
(
error
:
unknown
,
response
:
unknown
)
=>
void
Returns
Task
exec
exec
()
:
void
Returns
void
exec
As
Promise
execAsPromise
(
returnResponse
:
boolean
)
:
Promise
<
unknown
>
Parameters
returnResponse
:
boolean
Returns
Promise
<
unknown
>
log
log
(
levels
:
string
[]
,
logCallback
:
(
level
:
string
,
log
:
unknown
)
=>
void
)
:
Task
Parameters
levels
:
string
[]
logCallback
:
(
level
:
string
,
log
:
unknown
)
=>
void
Returns
Task
metric
Definition
Update
metricDefinitionUpdate
(
keys
:
string
[]
,
metricDefinitinUpdateCallback
:
(
metricDefinition
:
unknown
)
=>
void
,
)
:
Task
Parameters
keys
:
string
[]
metricDefinitinUpdateCallback
:
(
metricDefinition
:
unknown
)
=>
void
Returns
Task
metric
Update
metricUpdate
(
keys
:
string
[]
,
metricUpdateCallback
:
(
metricUpdate
:
unknown
)
=>
void
,
)
:
Task
Parameters
keys
:
string
[]
metricUpdateCallback
:
(
metricUpdate
:
unknown
)
=>
void
Returns
Task
new
Binary
Data
newBinaryData
(
topicIds
:
string
[]
,
dataListener
:
(
data
:
unknown
)
=>
void
)
:
Task
Parameters
topicIds
:
string
[]
dataListener
:
(
data
:
unknown
)
=>
void
Returns
Task
new
Data
newData
(
topicIds
:
string
[]
,
dataListener
:
(
data
:
unknown
)
=>
void
)
:
Task
Parameters
topicIds
:
string
[]
dataListener
:
(
data
:
unknown
)
=>
void
Returns
Task
progress
progress
(
progressCallback
:
(
label
:
string
,
progress
:
number
)
=>
void
)
:
Task
Parameters
progressCallback
:
(
label
:
string
,
progress
:
number
)
=>
void
Returns
Task
send
send
(
topicId
:
string
,
message
:
unknown
)
:
void
Parameters
topicId
:
string
message
:
unknown
Returns
void
set
Node
Id
setNodeId
(
nodeId
:
string
)
:
Task
Parameters
nodeId
:
string
Returns
Task
set
Time
Out
setTimeOut
(
value
:
number
,
unit
:
string
)
:
Task
Parameters
value
:
number
unit
:
string
Returns
Task
status
Change
statusChange
(
statusses
:
string
[]
,
statusChangeCallback
:
(
status
:
string
)
=>
void
,
)
:
Task
Parameters
statusses
:
string
[]
statusChangeCallback
:
(
status
:
string
)
=>
void
Returns
Task
success
success
(
successCallback
:
(
result
:
unknown
,
fullresponse
:
unknown
)
=>
void
)
:
Task
Parameters
successCallback
:
(
result
:
unknown
,
fullresponse
:
unknown
)
=>
void
Returns
Task
task
Info
taskInfo
(
taskInfoCallback
:
(
taskInfo
:
unknown
)
=>
void
)
:
Task
Parameters
taskInfoCallback
:
(
taskInfo
:
unknown
)
=>
void
Returns
Task
terminate
terminate
()
:
void
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
id
node
Id
request
task
Name
Methods
add
Stream
details
Update
error
exec
exec
As
Promise
log
metric
Definition
Update
metric
Update
new
Binary
Data
new
Data
progress
send
set
Node
Id
set
Time
Out
status
Change
success
task
Info
terminate
BIM.works SDKs - v1.5.0-b164
Loading...