Interface: ActivityModule

activity/activity.module.ActivityModule

• ActivityModuleImpl

• events

• createActivity
• destroyActivity
• refreshActivity
• findActivityById
• createExeUnit
• createScriptExecutor
• executeScript
• getBatchResults
• observeStreamingBatchEvents

• events: EventEmitter<ActivityEvents, any>

src/activity/activity.module.ts:12

▸ createActivity(agreement): Promise<Activity>

Create and start a new activity on the provider for the supplied agreement

Promise<Activity>

The resulting activity on the provider for further use

src/activity/activity.module.ts:19

▸ destroyActivity(activity): Promise<Activity>

Definitely terminate any work on the provider

Promise<Activity>

The activity that was permanently terminated

src/activity/activity.module.ts:26

▸ refreshActivity(staleActivity): Promise<Activity>

Fetches the latest state of the activity. It's recommended to use this method before performing any actions on the activity to make sure it's in the correct state. If the fetched activity's state is different from the one you have, an event will be emitted.

Promise<Activity>

src/activity/activity.module.ts:33

▸ findActivityById(activityId): Promise<Activity>

Fetches the activity by its ID from yagna. If the activity doesn't exist, an error will be thrown.

Promise<Activity>

src/activity/activity.module.ts:38

▸ createExeUnit(activity, options?): Promise<ExeUnit>

Create a exe-unit "within" the activity so that you can perform commands on the rented resources

Promise<ExeUnit>

An ExeUnit that's fully commissioned and the user can execute their commands

src/activity/activity.module.ts:45

▸ createScriptExecutor(activity, options?): ExeScriptExecutor

Factory method for creating a script executor for the activity

ExeScriptExecutor

src/activity/activity.module.ts:50

▸ executeScript(activity, script): Promise<string>

Execute a script on the activity.

Promise<string>

src/activity/activity.module.ts:55

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

Fetch the results of a batch execution.

Promise<Result<any>[]>

src/activity/activity.module.ts:60

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

Create an observable that will emit events from the streaming batch.

Observable<StreamingBatchEvent>

src/activity/activity.module.ts:65