Home Reference Source
import {PluginAdmin} from '@fnndsc/chrisapi'
public class | source

PluginAdmin

Extends:

ResourceItemResource → PluginAdmin

Plugin admin item resource object representing a plugin admin.

Constructor Summary

Public Constructor
public

constructor(url: string, auth: Object)

Constructor

Method Summary

Public Methods
public

delete(timeout: number): Promise

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

Inherited Summary

From class Resource
public static

cloneObj(obj: Object): *

Helper method to make a deep copy clone of the passed object resource.

public get

Return true if the resource object contains any data.

public
public
public
public
public

Make a deep copy clone of this object resource.

From class ItemResource
public get

Get the item's data object (REST API descriptors).

public
public

get(timeout: number): Promise<this>

Fetch this item resource from the REST API.

public

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.

Public Constructors

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

Constructor

Override:

ItemResource#constructor

Params:

NameTypeAttributeDescription
url string

url of the resource

auth Object

authentication object

auth.token string

authentication token

Public Methods

public delete(timeout: number): Promise source

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

Params:

NameTypeAttributeDescription
timeout number
  • optional
  • default: 30000

request timeout

Return:

Promise

JS Promise