import {PluginCollaborator} from '@fnndsc/chrisstoreapi'

public class | source

PluginCollaborator

Resource → ItemResource → PluginCollaborator

Plugin collaborator item resource object representing a plugin collaborator.

Constructor Summary

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

Public Methods
public	delete(timeout: number): Object Make a DELETE request to delete this plugin collaborator item resource through the REST API.
public	getPluginMeta(timeout: number): Object Fetch the plugin meta associated to this plugin collaborator from the REST API.
public	getUser(timeout: number): Object Fetch the user associated to this plugin collaborator from the REST API.
public	put(data: Object, timeout: number): Object Make a PUT request to modify this plugin collaborator item resource through 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

Make a DELETE request to delete this plugin collaborator item resource through the REST API.

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

JS Promise

Fetch the plugin meta associated to this plugin collaborator from the REST API.

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

JS Promise, resolves to a PluginMeta object

Fetch the user associated to this plugin collaborator from the REST API.

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

JS Promise, resolves to a User object

Make a PUT request to modify this plugin collaborator item resource through the REST API.

JS Promise, resolves to this object