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

Methods

getActivity

getActivity(id): Promise<Activity>

Parameters

NameType
idstring

Returns

Promise<Activity>

Defined in

src/activity/api.ts:35


createActivity

createActivity(agreement): Promise<Activity>

Parameters

NameType
agreementAgreement

Returns

Promise<Activity>

Defined in

src/activity/api.ts:37


destroyActivity

destroyActivity(activity): Promise<Activity>

Parameters

NameType
activityActivity

Returns

Promise<Activity>

Defined in

src/activity/api.ts:39


getActivityState

getActivityState(id): Promise<ActivityStateEnum>

Parameters

NameType
idstring

Returns

Promise<ActivityStateEnum>

Defined in

src/activity/api.ts:41


executeScript

executeScript(activity, script): Promise<string>

Parameters

NameType
activityActivity
scriptExeScriptRequest

Returns

Promise<string>

Defined in

src/activity/api.ts:43


getExecBatchResults

getExecBatchResults(activity, batchId, commandIndex?, timeout?): Promise<Result<any>[]>

Parameters

NameType
activityActivity
batchIdstring
commandIndex?number
timeout?number

Returns

Promise<Result<any>[]>

Defined in

src/activity/api.ts:45


getExecBatchEvents

getExecBatchEvents(activity, batchId, commandIndex?): Observable<StreamingBatchEvent>

Parameters

NameType
activityActivity
batchIdstring
commandIndex?number

Returns

Observable<StreamingBatchEvent>

Defined in

src/activity/api.ts:47