Manual Reference Source Test
public class | source

FlowKeyValue

Expression Extends:

class FlowKeyValue extends aggregate(FlowKeyValueModel, Helper)

Helper class representing Flow Data (Flow Process Value).

Test:

Constructor Summary

Public Constructor
public

Constructor for helper class representing Flow Data (Flow Process Value)

Member Summary

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

Method Summary

Public Methods
public

delete(): Promise<any>

Delete (soft delete / hide) a flow process value resource given an id

public

Public Constructors

public constructor(json: Object) source

Constructor for helper class representing Flow Data (Flow Process Value)

Params:

NameTypeAttributeDescription
json Object

json api response from server

Public Members

public get flow: Flow source

public set flow: Flow source

public get flowDataGroup: FlowDataGroup source

public set flowDataGroup: FlowDataGroup source

public get owner: Helper source

public set owner: Helper source

public get type: String source

Public Methods

public delete(): Promise<any> source

Delete (soft delete / hide) a flow process value resource given an id

http://clinical6-docs.s3-website-us-east-1.amazonaws.com/apidoc/v3data_collectionflow_process_values/destroy.html

Return:

Promise<any>

Promise object that returns success or failure

Example:

import { FlowKeyValue } from 'clinical6';

const kfv = new FlowKeyValue({...});
kfv.delete();

Test:

public save(): Promise<FlowKeyValue> source

Saves a flow key value (insert if id doesn't exist, update if it does)

http://clinical6-docs.s3-website-us-east-1.amazonaws.com/apidoc/v3data_collectionflow_process_values/create.html

Return:

Promise<FlowKeyValue>

Returns a promise via ajax call.

Example:

import { FlowKeyValue, flowService } from 'clinical6';

// Inserts new flow key value (no existing id)
const flowKeyValue = new FlowKeyValue({...});
flowKeyValue.save();

// Updates existing flowKeyValue (has existing id)
flowService.get().then(flowKeyValue => flowKeyValue.save());

Test: