yajsapi - JavaScript high-level API
Yagna Contributor Guide

Class: ActivityService

yajsapi / Exports / rest/activity / ActivityService

Class: ActivityService

rest/activity.ActivityService

A convenience helper to facilitate the creation of an Activity.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ActivityService(cfg)

Parameters

Name

Type

cfg

Configuration

Defined in

yajsapi/rest/activity.ts:29

Properties

_api

Private _api: RequestorControlApi

Defined in

yajsapi/rest/activity.ts:28

_state

Private _state: RequestorStateApi

Defined in

yajsapi/rest/activity.ts:29

Methods

_attest

_attest(activity_id, agreement, credentials): Promise

Parameters

Name

Type

activity_id

string

agreement

Agreement

credentials

Credentials

Returns

Promise

Defined in

yajsapi/rest/activity.ts:110

_create_activity

_create_activity(agreement_id): Promise<Activity>

Parameters

Name

Type

agreement_id

string

Returns

Promise<Activity>

Defined in

yajsapi/rest/activity.ts:59

_create_secure_activity

_create_secure_activity(agreement): Promise

Parameters

Name

Type

agreement

Agreement

Returns

Promise

Defined in

yajsapi/rest/activity.ts:67

new_activity

new_activity(agreement, secure?): Promise<Activity>

Create an activity within bounds of the specified agreement.

Parameters

Name

Type

Default value

Description

agreement

Agreement

undefined

-

secure

boolean

false

-

Returns

Promise<Activity>

Activity

Defined in

yajsapi/rest/activity.ts:43