Manual Reference Source Test
public class | source

ApproverAssignment

Helper class representing an consent approver assignment.

Example:

// To get a list of Approver Assignments you must have the approver group to get the approver assignment
import { clinical6, ApproverAssignment, ApproverGroup } from 'clinical6';
const approverGroup = new ApproverGroup({...}); // get the approverGroup in some way
approverGroup.getApproverAssignments().then(a => console.log(a)); // use getApproverAssignments
clinical6.getChildren(approverGroup, ApproverAssignment).then(a => console.log(a)); // or using get children

// To save or insert, you can either use the .save() capability or clinical6
myApproverAssignment.save(); // insert if no id, save if id
clinical6.insert(new ApproverAssignment({...}));
clinical6.update(myApproverAssignment);  (This is not yet implemented)

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

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an ApproverAssignment

Member Summary

Public Members
public get
public set
public get
public set

Method Summary

Public Methods
public

Deletes a approverAssignment

public

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

Inherited Summary

From class ApproverAssignmentModel
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing an ApproverAssignment

Override:

ApproverAssignmentModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get approver: ConsentFormVersion source

public set approver: ConsentFormVersion source

public get approverGroup: ApproverGroup source

public set approverGroup: ApproverGroup source

Public Methods

public delete(): Promise source

Deletes a approverAssignment

Return:

Promise

Returns a promise via ajax call.

Example:

import { ApproverAssignment, Client } from 'clinical6';

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

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

Test:

public save(): Promise<ApproverAssignment> source

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

Return:

Promise<ApproverAssignment>

Returns a promise via ajax call.

Example:

import { ApproverAssignment, clinical6 } from 'clinical6';

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

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

// Updates existing approverAssignment (has existing id)
clinical6.get(ApproverAssignment).then(approverAssignments => approverAssignments[0].save());

Test: