mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
# Upload Service
|
|
|
|
Provides access to various APIs related to file upload features.
|
|
|
|
## Basic Usage
|
|
|
|
### Events
|
|
|
|
| Name | Type | Description |
|
|
| --- | --- | --- |
|
|
| queueChanged | FileModel[] | Raised every time the file queue changes. |
|
|
| fileUpload | FileUploadEvent | Raised every time a File model changes its state. |
|
|
| fileUploadStarting | FileUploadEvent | Raised when upload starts. |
|
|
| fileUploadCancelled | FileUploadEvent | Raised when upload gets cancelled by user. |
|
|
| fileUploadProgress | FileUploadEvent | Raised during file upload process and contains the current progress for the particular File model. |
|
|
| fileUploadAborted | FileUploadEvent | Raised when file upload gets aborted by the server. |
|
|
| fileUploadError | FileUploadEvent | Raised when an error occurs to file upload. |
|
|
| fileUploadComplete | FileUploadCompleteEvent | Raised when file upload is complete. |
|
|
| fileUploadDelete | FileUploadDeleteEvent | Raised when uploaded file is removed from server. |
|
|
| fileDeleted | string | This can be invoked when a file is deleted from an external source to upload the file dialog status. |
|
|
|
|
## Details
|
|
|
|
### Ignore list configuration
|
|
|
|
Is possible add an ignore list for files that you don't want to allow upload on your CS.
|
|
The configuration of this service is saved in the ***app.config.json file***.If you want more details about the configuration service follow this [link](https://github.com/Alfresco/alfresco-ng2-components/tree/master/ng2-components/ng2-alfresco-core#appconfigservice).
|
|
In the example below you can see how filtered out the : '.git', '.DS_Store' and 'desktop.ini'. **Every element is a glob pattern string.** So, if you want to exclude all the txt files, you can add the "*.txt". (notice the asterisk at the beginning of the pattern!)
|
|
|
|
**app.config.json**
|
|
|
|
```json
|
|
{
|
|
"ecmHost": "http://localhost:3000/ecm",
|
|
"bpmHost": "http://localhost:3000/bpm",
|
|
"application": {
|
|
"name": "Alfresco"
|
|
},
|
|
"files": {
|
|
"excluded": [".DS_Store", "desktop.ini", ".git", "*.txt"]
|
|
}
|
|
}
|
|
```
|
|
|
|
Note:
|
|
- Standard glob patterns work.
|
|
- You can end patterns with a forward slash / to specify a directory.
|