Manual Reference Source Test
public class | source

SiteLanguage

Mixin Extends:

SiteLanguageModel, Helper

Helper class representing a supported site language.

Example:

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

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

Test:

Static Member Summary

Static Public Members
public static get

Constructor Summary

Public Constructor
public

Constructor for helper class representing a SiteLanguage

Member Summary

Public Members
public get
public set
public get
public set

Method Summary

Public Methods
public

Deletes a supported site language

public

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

Inherited Summary

From class SiteLanguageModel
public
public
public

Static Public Members

public static get type: String source

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing a SiteLanguage

Override:

SiteLanguageModel#constructor

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get language: Language source

public set language: Language source

public get site: Site source

public set site: Site source

Public Methods

public delete(): Promise<SiteLanguage> source

Deletes a supported site language

Return:

Promise<SiteLanguage>

Returns a promise via ajax call.

Example:

import { SiteLanguage, Client } from 'clinical6';

// Removes a supported site langauge from server and local storage
const siteLanguage = new SiteLanguage({...});
siteLanguage.delete();

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

Test:

public save(): Promise<SiteLanguage> source

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

Return:

Promise<SiteLanguage>

Returns a promise via ajax call.

Example:

import { SiteLanguage, clinical6 } from 'clinical6';

// Insert a SiteLanguage
const siteLanguage = new SiteLanguage({...});
siteLanguage.save();

// Updates existing siteLanguage (has existing id)
clinical6.get(SiteLanguage).then(siteLanguages => siteLanguages[0].save());

Test: