import ConsentStrategy from 'clinical6/src/helpers/consent/ConsentStrategy.js'

public class | source

ConsentStrategy

Mixin Extends:

ConsentStrategyModel, Helper

Helper class representing a Consent Strategy.

Example:

// To get a list of ConsentStrategies use clinical6.get
import { clinical6, ConsentStrategy } from 'clinical6';
clinical6.get(ConsentStrategy).then(c => console.log(c));

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

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

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

Test:

Static Member Summary

Static Public Members
public static get	type: String

Constructor Summary

Public Constructor
public	constructor(json: Object) Constructor for helper class representing a Consent Strategy

Member Summary

Public Members
public get	cohort: Cohort
public set	cohort: Cohort
public get	forms: ConsentForm[]
public set	forms: ConsentForm[]

Method Summary

Public Methods
public	delete(): Promise<ConsentStrategy> Deletes a consent strategy
public	async save(): Promise<ConsentStrategy> Saves a consent strategy (insert if id doesn't exist, update if it does)

Inherited Summary

From class ConsentStrategyModel
public	createdAt: String
public	id: Number
public	name: String
public	strategyType: String
public	updatedAt: String

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a Consent Strategy

Override:

ConsentStrategyModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public get cohort: Cohort source

public set cohort: Cohort source

public get forms: ConsentForm[] source

public set forms: ConsentForm[] source

Public Methods

public delete(): Promise<ConsentStrategy> source

Deletes a consent strategy

Return:

Promise<ConsentStrategy>

Returns a promise via ajax call.

Example:

import { ConsentStrategy, Client } from 'clinical6';

// Removes consent strategy from server and local storage
const consentStrategy = new ConsentStrategy({...});
consentStrategy.delete();

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

Test:

[unit] ConsentStrategy.delete should successfully delete a consentStrategy

public async save(): Promise<ConsentStrategy> source

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

Return:

Promise<ConsentStrategy>

Returns a promise via ajax call.

Example:

import { ConsentStrategy, clinical6 } from 'clinical6';

// Inserts new consentStrategy (no existing id)
const consentStrategy = new ConsentStrategy(
  "type": "consent__strategies",
  "attributes": {
    "name": "A form name",
    "strategy_type": "paper"
  });

consentStrategy.save();

// Updates existing consentStrategy(has existing id)
clinical6.get(ConsentStrategy).then(consentStrategies => consentStrategies[0].save());