Manual Reference Source Test
public class | source

ConsentGrant

Mixin Extends:

ConsentGrantModel, Helper

Helper class representing a Consent Grant.

Example:



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

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing a Consent Grant

Member Summary

Public Members
public get
public set
public get
public set
public set
public get
public get
public set
public set
public get
public get
public set

Method Summary

Public Methods
public

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

Inherited Summary

From class ConsentGrantModel
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 a Consent Grant

Override:

ConsentGrantModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get agreement: Agreement source

public set agreement: Agreement source

public get form: ConsentForm source

public set form: ConsentForm source

public set formVersion: ConsentFormVersion source

public get formVersion: ConsentFormVersion source

public get grantedBy: User source

public set grantedBy: User source

public set grantedFor: User source

public get grantedFor: User source

public get strategy: ConsentStrategy source

public set strategy: ConsentStrategy source

Public Methods

public async save(): Promise<ConsentGrant> source

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

Return:

Promise<ConsentGrant>

Returns a promise via ajax call.

Example:

import { ConsentGrant, clinical6 } from 'clinical6';

// Inserts new consentGrant (no existing id)
const consentGrant = new ConsentGrant({
type: "consent__grants",
attributes: {
  signing_password: "1212"
},
relationships: {
  granted_for: {
    data: {
      id: 12,
      type: "mobile_users"
    }
  },
  strategy: {
    data: {
      id: 1,
      type: "consent__strategies"
    }
  },
  form: {
    data: {
      id: 1,
      type: "consent__forms"
    }
  }
});

consentGrant.save();

// Updates existing consentGrant (has existing id)
clinical6.get(ConsentGrant).then(consentGrants => consentGrants[0].save());

Test: