import RelatedUser from 'clinical6/src/helpers/user/RelatedUser.js'

public class | source

RelatedUser

Mixin Extends:

RelatedUserModel, Helper

Helper class representing a RelatedUser.

Test:

Constructor Summary

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

Member Summary

Public Members
public get	followed: RelatedUser
public set	followed: RelatedUser
public get	follower: RelatedUser
public set	follower: RelatedUser
public get	type: String
public set	type: String

Private Members
private	_type: String

Method Summary

Public Methods
public	delete(relatedUser: *): Promise<RelatedUser> Deletes a relatedUser
public	save(relatedUser: *): Promise<RelatedUser> Saves a relatedUser (insert if id doesn't exist, update if it does)

Inherited Summary

From class RelatedUserModel
public	createdAt: Date
public	id: Number
public	relationship: String
public	type: String
public	updatedAt: Date

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a RelatedUser

Override:

RelatedUserModel#constructor

Params:

Name	Type	Attribute	Description
json	Object		json api response from server

Public Members

public get followed: RelatedUser source

public set followed: RelatedUser source

public get follower: RelatedUser source

public set follower: RelatedUser source

public get type: String source

Override:

RelatedUserModel#type

public set type: String source

Override:

RelatedUserModel#type

Private Members

private _type: String source

Public Methods

public delete(relatedUser: *): Promise<RelatedUser> source

Deletes a relatedUser

Params:

Name	Type	Attribute	Description
relatedUser	*	optional default: undefined

Return:

Promise<RelatedUser>

Returns a promise via ajax call.

Example:

import { RelatedUser, relatedUserService } from 'clinical6';

const relatedUser = new RelatedUser({...});

// Deletes relatedUser
relatedUser.delete();

Test:

[unit] RelatedUser.delete should successfully delete a relatedUser

public save(relatedUser: *): Promise<RelatedUser> source

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

Params:

Name	Type	Attribute	Description
relatedUser	*	optional default: undefined

Return:

Promise<RelatedUser>

Returns a promise via ajax call.

Example:

import { RelatedUser, relatedUserService } from 'clinical6';

const relatedUser = new RelatedUser({...});

// Updates relatedUser
relatedUser.save();