import AgreementTemplate from 'clinical6/src/helpers/agreement/AgreementTemplate.js'

public class | source

AgreementTemplate

Mixin Extends:

AgreementTemplateModel, Helper

Helper class representing AgreementTemplate.

Test:

Static Member Summary

Static Public Members
public static get	type: String

Constructor Summary

Public Constructor
public	constructor(json: Object) Constructor for helper class representing an Agreement Template

Member Summary

Public Members
public get	approvers: Object
public set	approvers: Object
public get	consentFormVersions: ConsentFormVersion
public set	consentFormVersions: ConsentFormVersion

Method Summary

Public Methods
public	save(): Promise<AgreementTemplate> Saves an agreement template (insert if id doesn't exist, update if it does)

Inherited Summary

From class AgreementTemplateModel
public	archivedAt: String
public	createdAt: String
public	description: String
public	documentUrl: String
public	expiration: Number
public	id: Number
public	message: String
public	permanentLink: String
public	redirectUrl: String
public	reminderFrequency: String
public	templateName: String
public	updatedAt: String

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing an Agreement Template

Override:

AgreementTemplateModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public get approvers: Object source

public set approvers: Object source

public get consentFormVersions: ConsentFormVersion source

public set consentFormVersions: ConsentFormVersion source

Public Methods

public save(): Promise<AgreementTemplate> source

Saves an agreement template (insert if id doesn't exist, update if it does)

Return:

Promise<AgreementTemplate>

Returns a promise via ajax call.

Example:

import { AgreementTemplate, clinical6 } from 'clinical6';

// Insert is different from other inserts.
const agreementTemplate = new AgreementTemplate({
  "template_name": "name",
  "permanent_link": "link",
  "description": "description",

});
agreementTemplate.save();


// Updates existing agreementTemplate (has existing id)
clinical6.get(AgreementTemplate).then(templates => templates[0].save());