[ADF-3.2.0] review link doc (#4689)

* review link doc
2025-07-24 17:32:15 +00:00 · 2019-05-03 14:30:35 +01:00
parent f40eb2560b
commit 42d02146fd
69 changed files with 736 additions and 579 deletions
--- a/docs/content-services/services/custom-resources.service.md
+++ b/docs/content-services/services/custom-resources.service.md
@@ -23,10 +23,11 @@ Manages Document List information that is specific to a user.
    -   _node:_ `any`  - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) object
    -   _nodeId:_ `string`  - ID of the node object
    -   **Returns** `string` - ID value
-   **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
+-   **getRecentFiles**(personId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), filters?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/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/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/development/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?
--- a/docs/content-services/services/document-actions.service.md
+++ b/docs/content-services/services/document-actions.service.md
@@ -17,14 +17,14 @@ Implements the document menu actions for the [Document List component](../compon
    Checks if actions can be executed for an item.
    -   _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)  - Item to receive an action
    -   **Returns** `boolean` - True if the action can be executed on this item, false otherwise
-   **getHandler**(key: `string`): `ContentActionHandler`<br/>
+-   **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)<br/>
    Gets the handler for an action.
    -   _key:_ `string`  - Identifier of the action
-    -   **Returns** `ContentActionHandler` - The handler for the action
-   **setHandler**(key: `string`, handler: `ContentActionHandler`): `boolean`<br/>
+    -   **Returns** [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - The handler for the action
+-   **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)): `boolean`<br/>
    Sets a new handler for an action.
    -   _key:_ `string`  - Identifier of the action
-    -   _handler:_ `ContentActionHandler`  - Handler for the action
+    -   _handler:_ [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)  - Handler for the action
    -   **Returns** `boolean` - False if the key was an empty/null string, true otherwise

 ## Details
--- a/docs/content-services/services/document-list.service.md
+++ b/docs/content-services/services/document-list.service.md
@@ -13,22 +13,15 @@ Implements node operations used by the [Document List component](../components/d

 ### Methods

-   **copyNode**(nodeId: `string`, targetParentId: `string`): `any`<br/>
+-   **copyNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
    Copy a node to destination node
    -   _nodeId:_ `string`  - The id of the node to be copied
    -   _targetParentId:_ `string`  - The id of the folder where the node will be copied
-    -   **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the copied node
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the copied node
 -   **deleteNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<any>`<br/>
    Deletes a node.
    -   _nodeId:_ `string`  - ID of the node to delete
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<any>` - Empty response when the operation is complete
-   **getDefaultMimeTypeIcon**(): `string`<br/>
-    Gets a default icon for MIME types with no specific icon.
-    -   **Returns** `string` - Path to the icon file
-   **getDocumentThumbnailUrl**(node: [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)): `string`<br/>
-    Get thumbnail URL for the given document node.
-    -   _node:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)  - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for.
-    -   **Returns** `string` - Thumbnail URL string
 -   **getFolder**(folder: `string`, opts?: `any`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodePaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/NodePaging.md)`>`<br/>
    Gets the folder node with the specified relative name path below the root node.
    -   _folder:_ `string`  - Path to folder.
@@ -40,20 +33,29 @@ Implements node operations used by the [Document List component](../components/d
    -   _nodeId:_ `string`  - ID of the folder node
    -   _includeFields:_ `string[]`  - Extra information to include (available options are "aspectNames", "isLink" and "association")
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
-   **getMimeTypeIcon**(mimeType: `string`): `string`<br/>
-    Gets the icon that represents a MIME type.
-    -   _mimeType:_ `string`  - MIME type to get the icon for
-    -   **Returns** `string` - Path to the icon file
 -   **getNode**(nodeId: `string`, includeFields: `string[]` = `[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
    Gets a node via its node ID.
    -   _nodeId:_ `string`  - ID of the target node
    -   _includeFields:_ `string[]`  - Extra information to include (available options are "aspectNames", "isLink" and "association")
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - Details of the folder
-   **moveNode**(nodeId: `string`, targetParentId: `string`): `any`<br/>
+-   **isCustomSourceService**(nodeId: `any`): `boolean`<br/>
+
+    -   _nodeId:_ `any`  - 
+    -   **Returns** `boolean` - 
+
+-   **loadFolderByNodeId**(nodeId: `string`, pagination: [`PaginationModel`](../../../lib/core/models/pagination.model.ts), includeFields: `string[]`, where?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/document-list/models/document-folder.model.ts)`>`<br/>
+
+    -   _nodeId:_ `string`  - 
+    -   _pagination:_ [`PaginationModel`](../../../lib/core/models/pagination.model.ts)  - 
+    -   _includeFields:_ `string[]`  - 
+    -   _where:_ `string`  - (Optional) 
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DocumentLoaderNode`](../../../lib/content-services/document-list/models/document-folder.model.ts)`>` - 
+
+-   **moveNode**(nodeId: `string`, targetParentId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`<br/>
    Moves a node to destination node.
    -   _nodeId:_ `string`  - The id of the node to be moved
    -   _targetParentId:_ `string`  - The id of the folder where the node will be moved
-    -   **Returns** `any` - [NodeEntry](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) for the moved node
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>` - NodeEntry for the moved node

 ## Details

--- a/docs/content-services/services/folder-actions.service.md
+++ b/docs/content-services/services/folder-actions.service.md
@@ -17,14 +17,14 @@ Implements the folder menu actions for the [Document List component](../componen
    Checks if an action is available for a particular item.
    -   _nodeEntry:_ [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)  - Item to check
    -   **Returns** `boolean` - True if the action is available, false otherwise
-   **getHandler**(key: `string`): `ContentActionHandler`<br/>
+-   **getHandler**(key: `string`): [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)<br/>
    Gets the handler function for an action.
    -   _key:_ `string`  - Identifier for the action
-    -   **Returns** `ContentActionHandler` - The handler function
-   **setHandler**(key: `string`, handler: `ContentActionHandler`): `boolean`<br/>
+    -   **Returns** [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts) - The handler function
+-   **setHandler**(key: `string`, handler: [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)): `boolean`<br/>
    Sets a new handler function for an action.
    -   _key:_ `string`  - Identifier for the action
-    -   _handler:_ `ContentActionHandler`  - The new handler function
+    -   _handler:_ [`ContentActionHandler`](../../../lib/content-services/document-list/models/content-action.model.ts)  - The new handler function
    -   **Returns** `boolean` - True if the key was a valid action identifier, false otherwise

 ## Details
--- a/docs/content-services/services/search-query-builder.service.md
+++ b/docs/content-services/services/search-query-builder.service.md
@@ -11,14 +11,6 @@ Stores information from all the custom search and faceted search widgets, compil

 ## Class members

-### Events
-
-| Name | Type | Details |
-| --- | --- | --- |
-| updated | QueryBody | Raised when query gets updated but before query is executed |
-| executed | ResultSetPaging | Raised when query gets executed and results are available |
-| error | any | Raised when search api emits internal error |
-
 ### Methods

 -   **addFilterQuery**(query: `string`)<br/>