import {FileBrowserFolder} from '@fnndsc/chrisapi'

public class | source

FileBrowserFolder

Resource → ItemResource → FileBrowserFolder

File browser folder item resource object representing a folder.

Method Summary

Public Methods
public	delete(timeout: number): Promise Make a DELETE request to delete this file browser folder item resource through the REST API.
public	getChildren(params: Object, timeout: number): Promise<FileBrowserFolderChildList> Fetch a list of folders that are the children of this folder from the REST API.
public	getFiles(params: Object, timeout: number): Promise<FileBrowserFolderFileList> Fetch a list of files directly under this folder from the REST API.
public	getLinkFiles(params: Object, timeout: number): Promise<FileBrowserFolderLinkFileList> Fetch a list of link files directly under this folder from the REST API.
public	getParent(timeout: number): Promise<FileBrowserFolder> Fetch the parent folder of this folder 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.

Make a DELETE request to delete this file browser folder item resource through the REST API.

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

JS Promise

Fetch a list of folders that are the children of this folder from the REST API.

JS Promise, resolves to a FileBrowserFolderChildList object

Fetch a list of files directly under this folder from the REST API.

JS Promise, resolves to a FileBrowserFolderFileList object

Fetch a list of link files directly under this folder from the REST API.

JS Promise, resolves to a FileBrowserFolderLinkFileList object

Fetch the parent folder of this folder from the REST API.

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

JS Promise, resolves to a FileBrowserFolder object