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

ApproverGroupAssignment

Helper class representing an consent approver group assignment.

Example:

// To get a list of Approver Group Assignments you must have the approver group first, then get it based on this approver group
import { clinical6, ApproverGroupAssignment } from 'clinical6';
const approverGroup = new ApproverGroup({...}); // get the approverGroup in some way
approverGroup.getApproverGroupAssignments().then(a => console.log(a)); // use getApproverGroupAssignments
clinical6.getChildren(approverGroup, ApproverGroupAssignment).then(a => console.log(a)); // or using get children

// To get a single approverGroup, you can also use clinical6
clinical6.get({ id: 5, type: 'consent__approver_groups'});

// To save or insert, you can either use the .save() capability or clinical6
myApproverGroupAssignment.save(); // insert if no id, save if id
clinical6.insert(new ApproverGroupAssignment({...}));
clinical6.update(myApproverGroupAssignment);

// To delete, use clinical6 or .delete();
myApproverGroupAssignment.delete();
clinical6.delete(myApproverGroupAssignment);

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an ApproverGroupAssignment

Member Summary

Public Members
public get
public set
public get
public set

Method Summary

Public Methods
public

Deletes an ApproverGroupAssignment

public

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

Inherited Summary

From class ApproverGroupAssignmentModel
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing an ApproverGroupAssignment

Override:

ApproverGroupAssignmentModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get approverGroup: ApproverGroup source

public set approverGroup: ApproverGroup source

public get formVersion: ConsentFormVersion source

public set formVersion: ConsentFormVersion source

Public Methods

public delete(): Promise source

Deletes an ApproverGroupAssignment

Return:

Promise

Returns a promise via ajax call.

Example:

import { ApproverGroupAssignment, Client } from 'clinical6';

// Removes approverGroupAssignment from server and local storage
const approverGroupAssignment = new ApproverGroupAssignment({...});
approverGroupAssignment.delete();

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

Test:

public save(): Promise<ApproverGroupAssignment> source

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

Return:

Promise<ApproverGroupAssignment>

Returns a promise via ajax call.

Example:

import { ApproverGroupAssignment, clinical6 } from 'clinical6';

// Insert is different from other inserts.
const approverGroupAssignment = new ApproverGroupAssignment({...});
approverGroupAssignment.save();

// After you have the authtoken and then you've logged in

// Updates existing approverGroupAssignment (has existing id)
clinical6.get(ApproverGroupAssignment).then(approverGroupAssignments => approverGroupAssignments[0].save());

Test: