Class: ActivityModuleImpl

activity/activity.module.ActivityModuleImpl

• ActivityModule

• constructor

• events

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

• new ActivityModuleImpl(services): ActivityModuleImpl

ActivityModuleImpl

src/activity/activity.module.ts:115

• Readonly events: EventEmitter<ActivityEvents, any>

ActivityModule.events

src/activity/activity.module.ts:109

▸ createScriptExecutor(activity, options?): ExeScriptExecutor

Factory method for creating a script executor for the activity

ExeScriptExecutor

ActivityModule.createScriptExecutor

src/activity/activity.module.ts:119

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

Execute a script on the activity.

Promise<string>

ActivityModule.executeScript

src/activity/activity.module.ts:123

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

Fetch the results of a batch execution.

Promise<Result<any>[]>

ActivityModule.getBatchResults

src/activity/activity.module.ts:156

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

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

Observable<StreamingBatchEvent>

ActivityModule.observeStreamingBatchEvents

src/activity/activity.module.ts:186

▸ 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

ActivityModule.createActivity

src/activity/activity.module.ts:217

▸ destroyActivity(activity): Promise<Activity>

Definitely terminate any work on the provider

Promise<Activity>

The activity that was permanently terminated

ActivityModule.destroyActivity

src/activity/activity.module.ts:237

▸ 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>

ActivityModule.refreshActivity

src/activity/activity.module.ts:258

▸ 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>

ActivityModule.findActivityById

src/activity/activity.module.ts:287

▸ 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

ActivityModule.createExeUnit

src/activity/activity.module.ts:292