mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
1fa81962a0
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
89 lines
8.3 KiB
Markdown
89 lines
8.3 KiB
Markdown
---
|
|
Title: Custom Resources service
|
|
Added: v2.3.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-16
|
|
---
|
|
|
|
# [Custom Resources service](../../../lib/content-services/src/lib/document-list/services/custom-resources.service.ts "Defined in custom-resources.service.ts")
|
|
|
|
Manages Document List information that is specific to a user.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **getCorrespondingNodeIds**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) = `{}`): [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>`<br/>
|
|
Gets the contents of one of the well-known aliases in the form of node ID strings.
|
|
- _nodeId:_ `string` - ID of the target folder node
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<string[]>` - List of node IDs
|
|
- **getIdFromEntry**(node: `any`, nodeId: `string`): `string`<br/>
|
|
Chooses the correct ID for a node entry.
|
|
- _node:_ `any` - Node object
|
|
- _nodeId:_ `string` - ID of the node object
|
|
- **Returns** `string` - ID value
|
|
- **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
|
|
Gets files recently accessed by a user.
|
|
- _personId:_ `string` - ID of the user
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _filters:_ `string[]` - (Optional) Specifies additional filters to apply (joined with **AND**)
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of nodes for the recently used files
|
|
- **hasCorrespondingNodeIds**(nodeId: `string`): `boolean`<br/>
|
|
Does the well-known alias have a corresponding node ID?
|
|
- _nodeId:_ `string` - Node to check
|
|
- **Returns** `boolean` - True if the alias has a corresponding node ID, false otherwise
|
|
- **isCustomSource**(folderId: `string`): `boolean`<br/>
|
|
Is the folder ID one of the well-known aliases?
|
|
- _folderId:_ `string` - Folder ID name to check
|
|
- **Returns** `boolean` - True if the ID is a well-known name, false otherwise
|
|
- **isSupportedSource**(folderId: `string`): `boolean`<br/>
|
|
Is the folder ID a "-my", "-root-", or "-shared-" alias?
|
|
- _folderId:_ `string` - Folder ID name to check
|
|
- **Returns** `boolean` - True if the ID is one of the supported sources, false otherwise
|
|
- **loadFavorites**(pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
|
|
Gets favorite files for the current user.
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _includeFields:_ `string[]` - List of data field names to include in the results
|
|
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of favorite files
|
|
- **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): `any`<br/>
|
|
Gets a folder's contents.
|
|
- _nodeId:_ `string` - ID of the target folder node
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _includeFields:_ `string[]` - List of data field names to include in the results
|
|
- _where:_ `string` - (Optional) Filters the Node list using the _where_ condition of the REST API (for example, isFolder=true). See the REST API documentation for more information.
|
|
- **Returns** `any` - List of items contained in the folder
|
|
- **loadMemberSites**(pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/>
|
|
Gets sites that the current user is a member of.
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SiteMemberPaging.md)`>` - List of sites
|
|
- **loadSharedLinks**(pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>`<br/>
|
|
Gets shared links for the current user.
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _includeFields:_ `string[]` - List of data field names to include in the results
|
|
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SharedLinkPaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/SharedLinkPaging.md)`>` - List of shared links
|
|
- **loadSites**(pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
|
|
Gets all sites in the repository.
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _where:_ `string` - (Optional) A string to restrict the returned objects by using a predicate
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/NodePaging.md)`>` - List of sites
|
|
- **loadTrashcan**(pagination: [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts), includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>`<br/>
|
|
Gets all items currently in the trash.
|
|
- _pagination:_ [`PaginationModel`](lib/core/src/lib/models/pagination.model.ts) - Specifies how to paginate the results
|
|
- _includeFields:_ `string[]` - List of data field names to include in the results
|
|
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DeletedNodesPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md)`>` - List of deleted items
|
|
|
|
## Details
|
|
|
|
The `includeFields` parameter used by some of the methods lets you specify which data fields
|
|
you want in the result objects. See the
|
|
[Alfresco JSAPI](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findSharedLinks)
|
|
for further details of the returned data and the available fields.
|
|
|
|
## See also
|
|
|
|
- [Document List component](../components/document-list.component.md)
|