JS API Reference
Interface: IActivityApi
activity/api.IActivityApi
Represents a set of use cases related to managing the lifetime of an activity
Implemented by
Table of contents
Methods
- getActivity
- createActivity
- destroyActivity
- getActivityState
- executeScript
- getExecBatchResults
- getExecBatchEvents
Methods
getActivity
▸ getActivity(id
): Promise
<Activity
>
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<Activity
>
Defined in
createActivity
▸ createActivity(agreement
): Promise
<Activity
>
Parameters
Name | Type |
---|---|
agreement | Agreement |
Returns
Promise
<Activity
>
Defined in
destroyActivity
▸ destroyActivity(activity
): Promise
<Activity
>
Parameters
Name | Type |
---|---|
activity | Activity |
Returns
Promise
<Activity
>
Defined in
getActivityState
▸ getActivityState(id
): Promise
<ActivityStateEnum
>
Parameters
Name | Type |
---|---|
id | string |
Returns
Promise
<ActivityStateEnum
>
Defined in
executeScript
▸ executeScript(activity
, script
): Promise
<string
>
Parameters
Name | Type |
---|---|
activity | Activity |
script | ExeScriptRequest |
Returns
Promise
<string
>
Defined in
getExecBatchResults
▸ getExecBatchResults(activity
, batchId
, commandIndex?
, timeout?
): Promise
<Result
<any
>[]>
Parameters
Name | Type |
---|---|
activity | Activity |
batchId | string |
commandIndex? | number |
timeout? | number |
Returns
Promise
<Result
<any
>[]>
Defined in
getExecBatchEvents
▸ getExecBatchEvents(activity
, batchId
, commandIndex?
): Observable
<StreamingBatchEvent
>
Parameters
Name | Type |
---|---|
activity | Activity |
batchId | string |
commandIndex? | number |
Returns
Observable
<StreamingBatchEvent
>