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

Resource

Direct Subclass:

ItemResource, ListResource

Indirect Subclass:

AllPluginInstanceList, AllWorkflowList, ChrisInstance, Comment, CommentList, ComputeResource, ComputeResourceAdmin, ComputeResourceAdminList, ComputeResourceList, DownloadToken, DownloadTokenList, Feed, FeedGroupPermission, FeedGroupPermissionList, FeedList, FeedPluginInstanceList, FeedTagList, FeedTaggingList, FeedUserPermission, FeedUserPermissionList, FileBrowserFolder, FileBrowserFolderChildList, FileBrowserFolderFile, FileBrowserFolderFileList, FileBrowserFolderLinkFile, FileBrowserFolderLinkFileList, FileBrowserFolderList, FileGroupPermission, FileGroupPermissionList, FileUserPermission, FileUserPermissionList, FolderGroupPermission, FolderGroupPermissionList, FolderUserPermission, FolderUserPermissionList, Group, GroupList, GroupUser, GroupUserList, LinkFileGroupPermission, LinkFileGroupPermissionList, LinkFileUserPermission, LinkFileUserPermissionList, Note, PACSFile, PACSFileList, PACSSeries, PACSSeriesList, Pipeline, PipelineList, PipelinePipingDefaultParameterList, PipelinePluginList, PipelinePluginPipingList, PipelineSourceFile, PipelineSourceFileList, PipingDefaultParameter, Plugin, PluginAdmin, PluginAdminList, PluginComputeResourceList, PluginInstance, PluginInstanceDescendantList, PluginInstanceList, PluginInstanceParameter, PluginInstanceParameterList, PluginInstanceSplit, PluginInstanceSplitList, PluginList, PluginMeta, PluginMetaList, PluginMetaPluginList, PluginParameter, PluginParameterList, PluginPiping, PublicFeedList, Tag, TagFeedList, TagList, TagTaggingList, Tagging, User, UserFile, UserFileList, UserGroupList, Workflow, WorkflowList, WorkflowPluginInstanceList

API abstract resource class.

Static Method Summary

Static Public Methods
public static

cloneObj(obj: Object): *

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

Constructor Summary

Public Constructor
public

constructor(url: string, auth: Object)

Constructor

Member Summary

Public Members
public
public
public
public get

Return true if the resource object contains any data.

public

Method Summary

Public Methods
public

Make a deep copy clone of this object resource.

Static Public Methods

public static cloneObj(obj: Object): * source

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

Params:

NameTypeAttributeDescription
obj Object

object to be cloned

Return:

*

clone object

Public Constructors

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

Constructor

Params:

NameTypeAttributeDescription
url string

url of the resource

auth Object
  • optional
  • default: null

authentication object

auth.token string
  • optional

authentication token

Public Members

public auth: Object source

public collection: Object source

public contentType: string source

public get isEmpty: boolean source

Return true if the resource object contains any data.

public url: string source

Public Methods

public clone(): Resource source

Make a deep copy clone of this object resource.

Return:

Resource

clone object