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

public class | source

EntryGroup

Mixin Extends:

EntryGroupModel, Helper

Helper class representing an eDiary Entry Group.

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 Group

Member Summary

Public Members
public get	children: EntryGroup
public set	children: EntryGroup
public get	entries: Entry
public set	entries: Entry
public get	parent: EntryGroup
public set	parent: EntryGroup
public get	templates: EntryTemplate[]
public set	templates: EntryTemplate[]

Method Summary

Public Methods
public	getTemplates(filters: Object, cacheMode: String): Promise<EntryTemplate[]\|EntryTemplate> Get eDiary entry templates

Inherited Summary

From class EntryGroupModel
public	category: String
public	createdAt: String
public	id: Number
public	name: String
public	permanentLink: String
public	position: 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 Group

Override:

EntryGroupModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public get children: EntryGroup source

public set children: EntryGroup source

public get entries: Entry source

public set entries: Entry source

public get parent: EntryGroup source

public set parent: EntryGroup source

public get templates: EntryTemplate[] source

public set templates: EntryTemplate[] source

Public Methods

public getTemplates(filters: Object, cacheMode: String): Promise<EntryTemplate[]|EntryTemplate> source

Get eDiary entry templates

Params:

Name	Type	Attribute	Description
filters	Object	optional	Filters to modify result (date, entry_group_id)
cacheMode	String	optional	Override the caching method for this call

Return:

Promise<EntryTemplate[]|EntryTemplate>

Promise object that returns one object or hashmap

Throw:

Clinical6Error

If missing token or missing required parameters

Example:

import { EntryGroup } from 'clinical6';
const group = new EntryGroup({ id: 15, ...});

// You will be able to access these entry groups using the `get` method.
group.getTemplates().then(templates => console.log(templates));

// You can also use the filter for automatic or manual
group.getTemplates({ category: 'automatic' }).then(templates => console.log(templates));

// additionally after the call, group.templates should now be the returned templates
console.log(group.templates);