ConsentGrant
Mixin Extends:
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);
Constructor Summary
Public Constructor | ||
public |
constructor(json: Object) 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 |
async save(): Promise<ConsentGrant> Saves a consent grant (insert if id doesn't exist, update if it does) |
Inherited Summary
From class ConsentGrantModel | ||
public |
|
|
public |
|
|
public |
documentUrl: * |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
Public Constructors
public constructor(json: Object) source
Constructor for helper class representing a Consent Grant
Override:
ConsentGrantModel#constructorParams:
Name | Type | Attribute | Description |
json | Object | json api response from server |
Public Members
public get form: ConsentForm source
public set form: ConsentForm source
public set formVersion: ConsentFormVersion source
public get formVersion: ConsentFormVersion 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)
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());