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

SiteMember

Mixin Extends:

SiteMemberModel, Helper

Helper class representing an siteMember.

Example:

import { SiteMember, clinical6 } from 'clinical6';

// Typically use SiteService.get()
clinical6.get(SiteMember).then(siteMembers => console.log(siteMembers));

const siteMember = new SiteMember({
  data: {
    id: 23,
    type: 'trials__site_members',
    attributes: {
      member_type: 'patient'
    },
    relationships: {
      mobile_user: {
        data: {
          type: 'mobile_users',
          id: 73
        }
      },
      site: {
        data: {
          type: 'trials__sites',
          id: 35
        }
      }
    }
  }
});

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing an SiteMember

Member Summary

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

Method Summary

Public Methods
public

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

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

Inherited Summary

From class SiteMemberModel
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 an SiteMember

Override:

SiteMemberModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get accessible: Object source

public set accessible: Object source

public set brand: Object source

public get brand: Object source

public get callback: Object source

public set callback: Object source

public get consentStrategy: ConsentStrategy source

public set consentStrategy: ConsentStrategy source

public get mobileUser: Profile source

public set mobileUser: Profile source

public get pointsRecords: Object source

public set pointsRecords: Object source

public set rewardEarnings: Object source

public get rewardEarnings: Object source

public get schedules: Object source

public set schedules: Object source

public get segmentations: Object source

public set segmentations: Object source

public get site: Site source

public set site: Site source

public set tag: Object source

public get tag: Object source

public get taggings: Object source

public set taggings: Object source

Public Methods

public delete(): Promise source

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

Return:

Promise

Returns a promise via ajax call.

Example:

import { SiteMember, Client } from 'clinical6';

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

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

Test:

public save(): Promise<SiteMember> source

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

Return:

Promise<SiteMember>

Returns a promise via ajax call.

Example:

import { SiteMember, clinical6 } from 'clinical6';

// Insert is different from other inserts.  Uses mobile application key
const siteMember = new SiteMember({
  "title": "You are a winner"
});
siteMember.save();

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

// Updates existing siteMember (has existing id)
clinical6.get(SiteMember).then(siteMembers => siteMembers[0].save());

Test: