mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Documentation build (#6762)
* move doc dependency in doctools * add ignore link * rebuild doc * version index * put it back some deps
This commit is contained in:
@@ -13,52 +13,52 @@ Displays and manages dialogs for selecting content to open, copy or upload.
|
||||
|
||||
### Methods
|
||||
|
||||
* **close**()<br/>
|
||||
- **close**()<br/>
|
||||
Closes the currently open dialog.
|
||||
* **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
|
||||
- **getTitleTranslation**(action: `string`, name: `string`): `string`<br/>
|
||||
Gets the translation of the dialog title.
|
||||
* *action:* `string` - Name of the action to display in the dialog title
|
||||
* *name:* `string` - Name of the item on which the action is being performed
|
||||
* **Returns** `string` - Translated version of the title
|
||||
* **openCopyMoveDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _action:_ `string` - Name of the action to display in the dialog title
|
||||
- _name:_ `string` - Name of the item on which the action is being performed
|
||||
- **Returns** `string` - Translated version of the title
|
||||
- **openCopyMoveDialog**(action: `string`, contentEntry: `Node`, permission?: `string`, excludeSiteContent?: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a dialog to copy or move an item to a new location.
|
||||
* *action:* `string` - Name of the action (eg, "Copy" or "Move") to show in the title
|
||||
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to be copied or moved
|
||||
* *permission:* `string` - (Optional) Permission for the operation
|
||||
* *excludeSiteContent:* `string[]` - (Optional) The site content that should be filtered out
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about files that were copied/moved
|
||||
* **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _action:_ `string` - Name of the action (eg, "Copy" or "Move") to show in the title
|
||||
- _contentEntry:_ `Node` - Item to be copied or moved
|
||||
- _permission:_ `string` - (Optional) Permission for the operation
|
||||
- _excludeSiteContent:_ `string[]` - (Optional) The site content that should be filtered out
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about files that were copied/moved
|
||||
- **openFileBrowseDialogByDefaultLocation**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a file browser at a default myFile location. shows files and folders in the dialog search result.
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
|
||||
* **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
|
||||
- **openFileBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a file browser at a chosen folder location. shows files and folders in the dialog search result.
|
||||
* *folderNodeId:* `string` - ID of the folder to use
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
|
||||
* **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _folderNodeId:_ `string` - ID of the folder to use
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
|
||||
- **openFileBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a file browser at a chosen site location. shows files and folders in the dialog search result.
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected file(s)
|
||||
* **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected file(s)
|
||||
- **openFolderBrowseDialogByFolderId**(folderNodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a folder browser at a chosen folder location.
|
||||
* *folderNodeId:* `string` - ID of the folder to use
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
|
||||
* **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _folderNodeId:_ `string` - ID of the folder to use
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected folder(s)
|
||||
- **openFolderBrowseDialogBySite**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a folder browser at a chosen site location.
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the selected folder(s)
|
||||
* **openLockNodeDialog**(contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the selected folder(s)
|
||||
- **openLockNodeDialog**(contentEntry: `Node`): [`Subject`](http://reactivex.io/documentation/subject.html)`<string>`<br/>
|
||||
Opens a lock node dialog.
|
||||
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) to lock
|
||||
* **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
|
||||
* **openUploadFileDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md), showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _contentEntry:_ `Node` - Node to lock
|
||||
- **Returns** [`Subject`](http://reactivex.io/documentation/subject.html)`<string>` - Error/status message (if any)
|
||||
- **openUploadFileDialog**(action: `string`, contentEntry: `Node`, showFilesInResult: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a dialog to choose a file to upload.
|
||||
* *action:* `string` - Name of the action to show in the title
|
||||
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
|
||||
* *showFilesInResult:* `boolean` - Show files in dialog search result
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen file(s)
|
||||
* **openUploadFolderDialog**(action: `string`, contentEntry: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>`<br/>
|
||||
- _action:_ `string` - Name of the action to show in the title
|
||||
- _contentEntry:_ `Node` - Item to upload
|
||||
- _showFilesInResult:_ `boolean` - Show files in dialog search result
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the chosen file(s)
|
||||
- **openUploadFolderDialog**(action: `string`, contentEntry: `Node`): [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>`<br/>
|
||||
Opens a dialog to choose folders to upload.
|
||||
* *action:* `string` - Name of the action to show in the title
|
||||
* *contentEntry:* [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md) - Item to upload
|
||||
* **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Node`](https://github.com/Alfresco/alfresco-js-api/blob/develop/src/api/content-rest-api/docs/Node.md)`[]>` - Information about the chosen folder(s)
|
||||
- _action:_ `string` - Name of the action to show in the title
|
||||
- _contentEntry:_ `Node` - Item to upload
|
||||
- **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<Node[]>` - Information about the chosen folder(s)
|
||||
|
||||
## Details
|
||||
|
||||
@@ -89,5 +89,5 @@ dialog operation, say) or be set to one of the well-known names "-my-" , "-share
|
||||
|
||||
## See Also
|
||||
|
||||
* [Content node selector panel component](../components/content-node-selector-panel.component.md)
|
||||
* [Content node selector component](../components/content-node-selector.component.md)
|
||||
- [Content node selector panel component](../components/content-node-selector-panel.component.md)
|
||||
- [Content node selector component](../components/content-node-selector.component.md)
|
||||
|
Reference in New Issue
Block a user