Class Folder

Hierarchy

HalResource
- Folder

Index

Constructors

constructor

Properties

Methods

Object literals

related

Constructors

constructor

new Folder(data?: any): Folder

Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:28
Creates a new instance of the resource. If data is provided it will be parsed as if it had come from the remote api.

Parameters
- Optional data: any
Returns Folder

Properties

Optional _links

_links: Map<string, HalLink>

Optional id

id: string

Optional name

name: string

Methods

Protected performActionWithoutResourceResponse

performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:155
POST to an action endpoint with no resource response returned.

Parameters
- name: string
- params: any
- data: any
- Default value method: POST | PATCH | PUT = HttpMethod.POST
Returns Promise<void>

toJSON

toJSON(): any

Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:53
Returns a copy of this resource's attributes excluding links and client references

Returns any

toJson

toJson(): any

Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:65
Returns a copy of this resource's attributes excluding links and client references

deprecated

Returns any

Object literals

Readonly related

related: object

Resources and actions related to a Folder

contentRepository

contentRepository(): Promise<ContentRepository>

- Defined in src/lib/model/Folder.ts:21
Retrieves the ContentRepository this folder is stored in

Returns Promise<ContentRepository>

contentItems

contentItems: object

list

list(options?: Pageable & Sortable): Promise<Page<ContentItem>>

- Defined in src/lib/model/Folder.ts:56
Retrieves a list of Content Items stored within this Folder

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<ContentItem>>

folders

folders: object

create

create(resource: Folder): Promise<Folder>

- Defined in src/lib/model/Folder.ts:47
Creates a folder beneath the folder

Parameters
- resource: Folder
  
  The new Folder to create
Returns Promise<Folder>

list

list(options?: Pageable & Sortable): Promise<Page<Folder>>

- Defined in src/lib/model/Folder.ts:35
Retrieves the list of sub-folders contained within this Folder

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<Folder>>

parent

parent(): Promise<Folder>

- Defined in src/lib/model/Folder.ts:28
Retrieves the parent folder of this Folder

Returns Promise<Folder>

Generated using TypeDoc