import EntryTemplate from 'clinical6/src/helpers/ediary/EntryTemplate.js'

public class | source

EntryTemplate

Mixin Extends:

EntryTemplateModel, Helper

Helper class representing an eDiary Entry Template.

Example:

import { MobileUser, EntryTemplate } from 'clinical6';
const template = new EntryTemplate({
    id: 12,
    type: 'ediary__entry_templates',
    attributes: {
      category: 'manual',
      created_at: '2017-06-27T20:32:59Z',
      updated_at: '2017-06-27T20:32:59Z'
    },
    relationships: {
      entry_group: {
        data: {
          id: '13',
          type: 'ediary__entry_groups'
        }
      },
      flow_process: {
        data: {
          id: '145',
          type: 'data_collection__flow_processes'
        }
      }
    }
  });

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 eDiary Entry Template

Member Summary

Public Members
public get	entryGroup: EntryGroup
public set	entryGroup: EntryGroup
public get	flow: Flow
public set	flow: Flow

Method Summary

Public Methods
public	async addEntry(entry: Entry, mobileUser: MobileUser): Promise<Entry[]\|Entry> Add eDiary Entry

Inherited Summary

From class EntryTemplateModel
public	category: String
public	createdAt: String
public	id: Number
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 eDiary Entry Template

Override:

EntryTemplateModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public get entryGroup: EntryGroup source

public set entryGroup: EntryGroup source

public get flow: Flow source

public set flow: Flow source

Public Methods

public async addEntry(entry: Entry, mobileUser: MobileUser): Promise<Entry[]|Entry> source

Add eDiary Entry

Params:

Name	Type	Attribute	Description
entry	Entry	nullable: false	Hashmap to save for entry
mobileUser	MobileUser	optional	The mobile user, must have id if exists
mobileUser.id	Number	nullable: false	The mobile user id

Return:

Promise<Entry[]|Entry>

Promise object that returns one object or hashmap

Throw:

Clinical6Error

If missing token or missing required parameters

Example:

import { MobileUser, EntryTemplate } from 'clinical6';
const mobileUser = new MobileUser({ id: 5, ... });
const template = new EntryTemplate({ id: 5, ... });
const data = { date: '2018-06-02' };

// You can add an entry using the `addEntry` method
template.addEntry(mobileUser, data).then(entry => console.log(entry));