import {PluginInstanceParameter} from '@fnndsc/chrisapi'

public class | source

PluginInstanceParameter

Resource → ItemResource → PluginInstanceParameter

Plugin instance parameter item resource object representing a parameter that the plugin instance was run with.

Method Summary

Public Methods
public	getPluginInstance(timeout: number): Promise<PluginInstance> Fetch the plugin instance associated to this parameter item from the REST API.
public	getPluginParameter(timeout: number): Promise<PluginParameter> Fetch the plugin parameter definition associated to this plugin instance item from the REST API.

From class Resource
public static	cloneObj(obj: Object): * Helper method to make a deep copy clone of the passed object resource.
public get	isEmpty: boolean Return true if the resource object contains any data.
public	auth: Object
public	collection: Object
public	contentType: string
public	url: string
public	clone(): Resource Make a deep copy clone of this object resource.

From class ItemResource
public get	data: Object Get the item's data object (REST API descriptors).
public	collection: *
public	get(timeout: number): Promise<this> Fetch this item resource from the REST API.
public	getPUTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in PUT requests.
private	_delete(timeout: number): Promise Internal helper method to make a DELETE request to this item resource through the REST API.
private	_getResource(linkRelation: string, ResourceClass: Object, searchParams: Object, timeout: number): Promise<ResourceClass> Internal method to fetch a related resource from the REST API that is referenced by a link relation within the item object.
private	_put(data: Object, uploadFileObj: Object, timeout: number): Promise<this> Internal helper method to make a PUT request to this item resource through the REST API.

Fetch the plugin instance associated to this parameter item from the REST API.

Name	Type	Attribute	Description
timeout	number	optional default: 30000	request timeout

JS Promise, resolves to a PluginInstance object

Fetch the plugin parameter definition associated to this plugin instance item from the REST API.

Name	Type	Attribute	Description
timeout	number	optional default: 30000	request timeout

JS Promise, resolves to a PluginParameter object