import {PluginMetaList} from '@fnndsc/chrisstoreapi'

public class | source

PluginMetaList

Extends:

Resource → ListResource → PluginMetaList

Plugin meta list resource object representing a list of plugin metas.

Constructor Summary

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

Member Summary

Public Members
public	itemClass: Object

Method Summary

Public Methods
public	getCollabPluginMetas(params: Object, timeout: number): Object Fetch a list of plugin metas for which the authenticated user is a collaborator from the REST API.
public	getFavoritePluginMetas(params: Object, timeout: number): Object Fetch a list of authenticated user's favorite plugin metas from the REST API.
public	getPipelines(searchParams: Object, timeout: number): Object Fetch a list of pipelines from the REST API.
public	getPluginStars(searchParams: Object, timeout: number): Object Fetch a list of plugin stars from the REST API.
public	getPlugins(searchParams: Object, timeout: number): Object Fetch a list of plugins from the REST API.
public	getUser(timeout: number): Object Fetch the authenticated user from the REST API.

Inherited Summary

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 ListResource
public get	data: Object[] Get the list of item data objects (REST API descriptors).
public get	hasNextPage: boolean Return true if the list resource object has a next list page in the paginated REST API.
public get	hasPreviousPage: boolean Return true if the list resource object has a previous list page in the paginated REST API.
public get	totalCount: number Get the total count of items of the entire collection across pages in the paginated REST API.
public	collection: *
public	itemClass: Object
public	queryUrl: string
public	searchParams: Object
public	get(searchParams: Object, timeout: number): Object Fetch this list resource from the REST API based on search parameters.
public	getItem(id: number): Object Get an item resource object given its id from the list of items in this list resource object.
public	getItems(): Object[] Get an array of item resource objects corresponding to the items in this list resource object.
public	getPOSTParameters(): string[] Get an array of parameter names that can be used as properties of the data object in POST requests.
public	getSearchParameters(): string[] Get an array of search parameter names that can be used as properties of the `searchParams` argument to the `get` method.
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 this list resource's collection object.
private	_post(data: Object, uploadFileObj: Object, timeout: number): Object Internal helper method to make a POST request to this list resource through the REST API.

Public Constructors

public constructor(url: string, auth: Object) source

Constructor

Override:

ListResource#constructor

Params:

Name	Type	Attribute	Description
url	string		url of the resource
auth	Object	optional default: null	authentication object
auth.token	string	optional	authentication token

Public Members

public itemClass: Object source

Override:

ListResource#itemClass

Public Methods

public getCollabPluginMetas(params: Object, timeout: number): Object source

Fetch a list of plugin metas for which the authenticated user is a collaborator from the REST API.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters object
params.limit	number	optional	page limit
params.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a UserCollabPluginMetaList object

public getFavoritePluginMetas(params: Object, timeout: number): Object source

Fetch a list of authenticated user's favorite plugin metas from the REST API.

Params:

Name	Type	Attribute	Description
params	Object	optional default: null	page parameters object
params.limit	number	optional	page limit
params.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a UserFavoritePluginMetaList object

public getPipelines(searchParams: Object, timeout: number): Object source

Fetch a list of pipelines from the REST API.

Params:

Name	Type	Attribute	Description
searchParams	Object	optional default: null	search parameters object which is resource-specific, the `PipelineList.getSearchParameters` method can be used to get a list of possible search parameters
searchParams.limit	number	optional	page limit
searchParams.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PipelineList object

public getPluginStars(searchParams: Object, timeout: number): Object source

Fetch a list of plugin stars from the REST API.

Params:

Name	Type	Attribute	Description
searchParams	Object	optional default: null	search parameters object which is resource-specific, the `PluginStarList.getSearchParameters` method can be used to get a list of possible search parameters
searchParams.limit	number	optional	page limit
searchParams.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PluginStarList object

public getPlugins(searchParams: Object, timeout: number): Object source

Fetch a list of plugins from the REST API.

Params:

Name	Type	Attribute	Description
searchParams	Object	optional default: null	search parameters object which is resource-specific, the `PluginList.getSearchParameters` method can be used to get a list of possible search parameters
searchParams.limit	number	optional	page limit
searchParams.offset	number	optional	page offset
timeout	number	optional default: 30000	request timeout

Return:

Object

JS Promise, resolves to a PluginList object

public getUser(timeout: number): Object source

Fetch the authenticated user from the REST API.

Params:

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

Return:

Object

JS Promise, resolves to a User object