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

ConsultationParticipant

Expression Extends:

class ConsultationParticipant extends aggregate(ConsultationParticipantModel, Helper)

Helper class representing a ConsultationParticipant.

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an Video Consultation

Member Summary

Public Members
public get
public set
public get
public set

Method Summary

Public Methods
public

Deletes a consultation

public

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

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing an Video Consultation

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get consultation: Consultation source

public set consultation: Consultation source

public get user: User source

public set user: User source

Public Methods

public delete(): Promise source

Deletes a consultation

Return:

Promise

Returns a promise via ajax call.

Example:

import { ConsultationParticipant, Client } from 'clinical6';

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

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

Test:

public async save(): Promise<ConsultationParticipant> source

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

Return:

Promise<ConsultationParticipant>

Returns a promise via ajax call.

Example:

import { ConsultationParticipant, clinical6 } from 'clinical6';

// Inserts new role (no existing id)
const consultation = new ConsultationParticipant({
  "data": {
    "type": "video_consultation_participants",
    "attributes": {},
    "relationships": {
      "video_consultation": {
        "data": {
          "id": 18,
          "type": "video_consultations"
        }
      },
      "participant": {
        "data": {
          "id": 527,
          "type": "mobile_users"
        }
      }
    }
  }
});
consultation.save();
// Updates existing consultation if it has an existing id

Test: