Manual Reference Source Test
import AgreementService from 'clinical6/src/services/AgreementService.js'
public class | source

AgreementService

Extends:

AbstractServiceJsonApiService → AgreementService

Service handling System Utility calls.

Method Summary

Public Methods
public

get(id: Number, recipients: String[], options: Object): Promise<Agreement>

Sends a request to create an Adobe Sign document, if a document exists for the given recipients, that same document its returned.

Inherited Summary

From class AbstractService
public get
public set
public
private
From class JsonApiService
public

options: *

public

async delete(obj: Object, options: String): Promise

Call a DELETE request on the main obj.type expecting JSON API information.

public

async get(params: Object, options: String): Promise

Call a GET request expecting JSON API information.

public

async getChildren(parent: Object, child: Object, options: String): Promise

Call a GET request expecting JSON API information for children given a parent.

public

async insert(obj: Object, options: String): Promise

Call a POST request on the main obj.type expecting JSON API information.

public

async update(obj: Object, options: String): Promise

Call a PATCH request on the main obj.type expecting JSON API information.

Public Methods

public get(id: Number, recipients: String[], options: Object): Promise<Agreement> source

Sends a request to create an Adobe Sign document, if a document exists for the given recipients, that same document its returned.

Override:

JsonApiService#get

Params:

NameTypeAttributeDescription
id Number

The id of the document to be signed

recipients String[]

The list of users that will sign the document with the given email and user role.

options Object

A hash of key values, to indicate custom attribues for the pdf values.

Return:

Promise<Agreement>

Returns the agreement in a promise

Test: