eLabSDK.SampleLink

Classes

Name	Description
eLabSDK

Name	Description
getSampleList(callback)	Retrieve the list of sample that can be linked to the current sample
getSampleLink(linkedSampleID, callback)	Retrieve the current linked sample name
getSampleInfo(linkedSampleID, callback)	Retrieve the current linked sample info
sendErrorMessage(message, callback)	Send an error message
copyLinkedSampleMetaFields(linkedSampleID, :)	Copy meta field from specified linked sample
updateField(fieldLabel, fieldType, value)	Update the specified fields with their new value

Kind: global class

This is the description for my class.

Retrieve the list of sample that can be linked to the current sample

Kind: global function

Param	Type	Description
callback	`function`	: function to execute once the list has been retrieved

Retrieve the current linked sample name

Kind: global function

Param	Type	Description
linkedSampleID	`int`	: ID of the linked sample to retrieve
callback	`function`	: function to execute once the sample has been retrieved

Retrieve the current linked sample info

Kind: global function

Param	Type	Description
linkedSampleID	`int`	: ID of the linked sample to retrieve
callback	`function`	: function to execute once the sample has been retrieved

Send an error message

Kind: global function

Param	Type	Description
message	`string`	: error message
callback	`function`	: function to send the error message to

Copy meta field from specified linked sample

Kind: global function

Param	Type	Description
linkedSampleID	`int`	: Linked sample ID to copy the fields from
:	`array`	Array of meta fields to copy

Update the specified fields with their new value

Kind: global function

Param	Type	Description
fieldLabel	`string`	: Field label to copy the new value to
fieldType	`string`	: Field type to copy to (for now, only COMBO and TEXT supported)
value	`string`	: New field value