mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
1d517d3a8a
* [ADF-2557] Updated docs for services with new props script * [ADF-2557] Updated service docs with new props script
82 lines
3.5 KiB
Markdown
82 lines
3.5 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-04-05
|
|
---
|
|
|
|
# Upload Service
|
|
|
|
Provides access to various APIs related to file upload features.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- `addToQueue(files: FileModel[] = null): FileModel[]`<br/>
|
|
Adds files to the uploading queue to be uploaded
|
|
- `files: FileModel[] = null` - One or more separate parameters or an array of files to queue
|
|
- **Returns** `FileModel[]` - Array of files that were not blocked from upload by the ignore list
|
|
- `cancelUpload(files: FileModel[] = null)`<br/>
|
|
Cancels uploading of files.
|
|
- `files: FileModel[] = null` - One or more separate parameters or an array of files specifying uploads to cancel
|
|
- `clearQueue()`<br/>
|
|
Clears the upload queue
|
|
- `getQueue(): FileModel[]`<br/>
|
|
Gets the file Queue
|
|
- **Returns** `FileModel[]` - Array of files that form the queue
|
|
- `getUploadPromise(file: FileModel = null): any`<br/>
|
|
Gets an upload promise for a file.
|
|
- `file: FileModel = null` - The target file
|
|
- **Returns** `any` - Promise that is resolved if the upload is successful or error otherwise
|
|
- `isUploading(): boolean`<br/>
|
|
Checks whether the service is uploading a file.
|
|
- **Returns** `boolean` - True if a file is uploading, false otherwise
|
|
- `uploadFilesInTheQueue(emitter: EventEmitter<any> = null)`<br/>
|
|
Finds all the files in the queue that are not yet uploaded and uploads them into the directory folder.
|
|
- `emitter: EventEmitter<any> = null` - (Deprecated) Emitter to invoke on file status change
|
|
|
|
## Events
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| queueChanged | FileModel\[] | Emitted when the file queue changes. |
|
|
| fileUpload | FileUploadEvent | Emitted when a File model changes its state. |
|
|
| fileUploadStarting | FileUploadEvent | Emitted when an upload starts. |
|
|
| fileUploadCancelled | FileUploadEvent | Emitted when an upload gets cancelled by the user. |
|
|
| fileUploadProgress | FileUploadEvent | Emitted during the file upload process and contains the current progress for a particular File model. |
|
|
| fileUploadAborted | FileUploadEvent | Emitted when a file upload gets aborted by the server. |
|
|
| fileUploadError | FileUploadEvent | Emitted when an error occurs during a file upload. |
|
|
| fileUploadComplete | FileUploadCompleteEvent | Emitted when a file upload is complete. |
|
|
| fileUploadDelete | FileUploadDeleteEvent | Emitted when an 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
|
|
|
|
You can add an ignore list for files that you don't want to be uploaded on your CS.
|
|
The configuration of this service is saved in the `app.config.json` file
|
|
(see the [App Config service](app-config.service.md) for more information).
|
|
|
|
The example below shows how to filter out the : '.git', '.DS_Store' and 'desktop.ini' files.
|
|
Each element of the ignore list is a glob pattern string, so you could exclude all the `.txt`
|
|
files, for example, by adding a `*.txt` pattern to the list.
|
|
|
|
**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 that all standard glob patterns work and you can end patterns with a forward
|
|
slash `/` character to specify a directory.
|