import {PipingDefaultParameter} from '@fnndsc/chrisstoreapi'

public class | source

PipingDefaultParameter

Resource → ItemResource → PipingDefaultParameter

Item resource object for a plugin piping defaul parameter representing a default value for a plugin parameter associated with this plugin piping.

Constructor Summary

Public Constructor
public	constructor(url: string, auth: Object) Constructor

Public Methods
public	getPluginParameter(timeout: number): Object Fetch the corresponding plugin parameter for this plugin piping default parameter from the REST API.
public	getPluginPiping(timeout: number): Object Fetch the corresponding plugin piping for this plugin piping default parameter from the REST API.

From class 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(): Object 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): Object 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): Object 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): Object 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): Object Internal helper method to make a PUT request to this item resource through the REST API.

Constructor

Fetch the corresponding plugin parameter for this plugin piping default parameter from the REST API.

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

JS Promise, resolves to a PluginParameter object

Fetch the corresponding plugin piping for this plugin piping default parameter from the REST API.

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

JS Promise, resolves to a PluginPiping object