mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2670] Added new docs for 2.3 features (#3181)
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
893cefa9ee
commit
014f2ab26c
@@ -46,14 +46,13 @@ for more information about installing and using the source code.
|
||||
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Node download directive](node-download.directive.md) | Allows folders and/or files to be downloaded. Multiple nodes are packed as a '.ZIP' archive. | [Source](../../lib/content-services/directives/node-download.directive.ts) |
|
||||
| [Node lock directive](node-lock.directive.md) | Call [`ContentNodeDialogService.openLockNodeDialog(nodeEntry)`](./content-node-dialog.service.md) method on click event,
|
||||
and disable target button if provided node is not a file or user don't have permissions. | [Source](../../lib/content-services/directives/node-lock.directive.ts) |
|
||||
| [Node share directive](node-share.directive.md) | Create and manage public shared links for files | [Source](../../lib/content-services/directives/node-share.directive.ts) |
|
||||
| [Folder create directive](folder-create.directive.md) | Allows folders to be created. | [Source](../../lib/content-services/folder-directive/folder-create.directive.ts) |
|
||||
| [Node download directive](node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../../lib/content-services/directives/node-download.directive.ts) |
|
||||
| [Node lock directive](node-lock.directive.md) | Locks a node. | [Source](../../lib/content-services/directives/node-lock.directive.ts) |
|
||||
| [Node share directive](node-share.directive.md) | Creates and manages public shared links for files. | [Source](../../lib/content-services/directives/node-share.directive.ts) |
|
||||
| [Folder create directive](folder-create.directive.md) | Creates folders. | [Source](../../lib/content-services/folder-directive/folder-create.directive.ts) |
|
||||
| [Folder edit directive](folder-edit.directive.md) | Allows folders to be edited. | [Source](../../lib/content-services/folder-directive/folder-edit.directive.ts) |
|
||||
| [Inherited button directive](inherited-button.directive.md) | Update the current node by adding/removing the inherited permissions. | [Source](../../lib/content-services/permission-manager/components/inherited-button.directive.ts) |
|
||||
| [File draggable directive](file-draggable.directive.md) | Provide drag-and-drop features for an element such as a `div`. | [Source](../../lib/content-services/upload/directives/file-draggable.directive.ts) |
|
||||
| [File draggable directive](file-draggable.directive.md) | Provides drag-and-drop features for an element such as a `div`. | [Source](../../lib/content-services/upload/directives/file-draggable.directive.ts) |
|
||||
|
||||
## Models
|
||||
|
||||
@@ -67,13 +66,13 @@ and disable target button if provided node is not a file or user don't have perm
|
||||
| Name | Description | Source link |
|
||||
| ---- | ----------- | ----------- |
|
||||
| [Content node dialog service](content-node-dialog.service.md) | Displays and manages dialogs for selecting content to open, copy or upload. | [Source](../../lib/content-services/content-node-selector/content-node-dialog.service.ts) |
|
||||
| [Custom resources service](custom-resources.service.md) | Manages Document List information that is specific to a user. | [Source](../../lib/content-services/document-list/services/custom-resources.service.ts) |
|
||||
| [Document actions service](document-actions.service.md) | Implements the document menu actions for the Document List component. | [Source](../../lib/content-services/document-list/services/document-actions.service.ts) |
|
||||
| [Document list service](document-list.service.md) | Implements node operations used by the Document List component. | [Source](../../lib/content-services/document-list/services/document-list.service.ts) |
|
||||
| [Folder actions service](folder-actions.service.md) | Implements the folder menu actions for the Document List component. | [Source](../../lib/content-services/document-list/services/folder-actions.service.ts) |
|
||||
| [Node permission service](node-permission.service.md) | Manages the role permissions for the content nodes | [Source](../../lib/content-services/permission-manager/services/node-permission.service.ts) |
|
||||
| [Rating service](rating.service.md) | Manages ratings for items in Content Services. | [Source](../../lib/content-services/social/services/rating.service.ts) |
|
||||
| [Tag service](tag.service.md) | Manages tags in Content Services. | [Source](../../lib/content-services/tag/services/tag.service.ts) |
|
||||
| _Custom resources service_ | _Not currently documented_ | [Source](../../lib/content-services/document-list/services/custom-resources.service.ts) |
|
||||
| _Search query builder service_ | _Not currently documented_ | [Source](../../lib/content-services/search/search-query-builder.service.ts) |
|
||||
|
||||
<!--content-services end-->
|
||||
|
||||
68
docs/content-services/custom-resources.service.md
Normal file
68
docs/content-services/custom-resources.service.md
Normal file
@@ -0,0 +1,68 @@
|
||||
---
|
||||
Added: v2.3.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-04-12
|
||||
---
|
||||
|
||||
# Custom Resources service
|
||||
|
||||
Manages Document List information that is specific to a user.
|
||||
|
||||
## Class members
|
||||
|
||||
### Methods
|
||||
|
||||
- `getRecentFiles(personId: string, pagination: PaginationModel): Observable<NodePaging>`<br/>
|
||||
Gets files recently accessed by a user.
|
||||
- `personId: string` - ID of the user
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- **Returns** `Observable<NodePaging>` - List of nodes for the recently used files
|
||||
- `loadFavorites(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
|
||||
Gets favorite files for the current user.
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- `includeFields: string[] = []` - List of data field names to include in the results
|
||||
- **Returns** `Observable<NodePaging>` - List of favorite files
|
||||
- `loadMemberSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
|
||||
Gets sites that the current user is a member of.
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- **Returns** `Observable<NodePaging>` - List of sites
|
||||
- `loadSites(pagination: PaginationModel): Observable<NodePaging>`<br/>
|
||||
Gets all sites in the respository.
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- **Returns** `Observable<NodePaging>` - List of sites
|
||||
- `loadTrashcan(pagination: PaginationModel, includeFields: string[] = []): Observable<DeletedNodesPaging>`<br/>
|
||||
Gets all items currently in the trash.
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- `includeFields: string[] = []` - List of data field names to include in the results
|
||||
- **Returns** `Observable<DeletedNodesPaging>` - List of deleted items
|
||||
- `loadSharedLinks(pagination: PaginationModel, includeFields: string[] = []): Observable<NodePaging>`<br/>
|
||||
Gets shared links for the current user.
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- `includeFields: string[] = []` - List of data field names to include in the results
|
||||
- **Returns** `Observable<NodePaging>` - List of shared links
|
||||
- `isCustomSource(folderId: string): boolean`<br/>
|
||||
Is the folder ID one of the well-known aliases?
|
||||
- `FolderId` - Folder ID name to check
|
||||
- **Returns** `Observable<NodePaging>` - True if the ID is a well-known name, false otherwise
|
||||
- `loadFolderByNodeId(nodeId: string, pagination: PaginationModel, includeFields: string[]): Observable<NodePaging>`<br/>
|
||||
Gets a folder's contents.
|
||||
- `nodeId: string` - ID of the target folder node
|
||||
- `pagination: PaginationModel` - Specifies how to paginate the results
|
||||
- `includeFields: string[] = []` - List of data field names to include in the results
|
||||
- **Returns** `Observable<NodePaging>` - List of items contained in the folder
|
||||
- `getCorrespondingNodeIds(nodeId: string, pagination: PaginationModel): Observable<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` - Specifies how to paginate the results
|
||||
- **Returns** `Observable<string[]>` - List of node IDs
|
||||
|
||||
## 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](document-list.component.md)
|
||||
Reference in New Issue
Block a user