Manual Reference Source Test
public class | source

ContentAttribute

Helper class representing an eDiary Entry Group.

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an eDiary Entry Group

Member Summary

Public Members
public get
public set

Method Summary

Public Methods
public

delete(): Promise<any>

Deletes an attribute

public

Saves a content attribute (insert if id doesn't exist, update if it does)

Inherited Summary

From class ContentAttributeModel
public
public
public
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 eDiary Entry Group

Override:

ContentAttributeModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get contentType: ContentType source

public set contentType: ContentType source

Public Methods

public delete(): Promise<any> source

Deletes an attribute

Return:

Promise<any>

Returns a promise via ajax call.

Example:

import { ContentAttribute, Client } from 'clinical6';

// Removes content from server and local storage
const contentAttribute = new ContentAttribute({...});
contentAttribute.delete();

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

Test:

public async save(): Promise<ContentAttribute> source

Saves a content attribute (insert if id doesn't exist, update if it does)

Return:

Promise<ContentAttribute>

Returns a promise via ajax call.

Example:

import { ContentAttribute, clinical6 } from 'clinical6';

// Inserts new contentAttribute (no existing id)
const contentAttribute = new ContentAttribute(
  "type": "dynamic_content__attribute_keys",
  "attributes": {
    "required": true
  });

contentAttribute.save();

// Updates existing contentAttribute(has existing id)
clinical6.get(ContentAttribute).then(contentAttributes => contentAttributes[0].save());

Test: