Manual Reference Source Test 
import AgreementTemplateField from 'clinical6/src/helpers/agreement/AgreementTemplateField.js'
public class | source

AgreementTemplateField

Mixin Extends:

AgreementTemplateFieldModel, Helper

Helper class representing AgreementTemplateField.

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an Agreement Template Field

Member Summary

Public Members
public get
public set

Method Summary

Public Methods
public

Deletes an agreement template field
public

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

Inherited Summary

From class AgreementTemplateFieldModel
public
public
public
public
public
public
public
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing an Agreement Template Field

Override:

AgreementTemplateFieldModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get agreementTemplate: AgreementTemplate source

public set agreementTemplate: AgreementTemplate source

Public Methods

public delete(): Promise source

Deletes an agreement template field

Return:

Promise

Returns a promise via ajax call.

Example:

import { AgreementTemplateField, Client } from 'clinical6';

// Removes an agreement template field from server and local storage
const field = new AgreementTemplateField({...});
field.delete();

// No longer in storage
Client.instance.storageUtility.has('agreement__template_fields', { id: 1 });

public save(): Promise<AgreementTemplateField> source

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

Return:

Promise<AgreementTemplateField>

Returns a promise via ajax call.

Example:

import { AgreementTemplateField, clinical6 } from 'clinical6';

// Insert is different from other inserts.
const agreementTemplateField = new AgreementTemplateField({
  "label": "Label for field 1",
  "field_name": "template_field_1",
  "required": false,
  "default_value": "DEFAULT_VALUE",
  "attribute_name": "template_field_1_attribute",
  "signer_index": 1,
  "source_type": "mobile_user",
  "relationships": {
   "agreement_template": {
      "data": {
        "type": "agreement__template",
        "id": 1
      }
    }
  }
});
agreementTemplate.save();


// Updates existing agreementTemplateField (has existing id)
clinical6.get(AgreementTemplateField).then(templateFields => templateFields[0].save());

Test: