mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Update doc (#8085)
This commit is contained in:
Eugenio Romano
GitHub
@@ -5,7 +5,7 @@ Status: Active
|
||||
Last reviewed: 2019-01-16
|
||||
---
|
||||
|
||||
# [Upload Service](lib/core/src/lib/services/upload.service.ts "Defined in upload.service.ts")
|
||||
# [Upload Service](../../../lib/core/src/lib/services/upload.service.ts "Defined in upload.service.ts")
|
||||
|
||||
Provides access to various APIs related to file upload features.
|
||||
|
||||
@@ -13,26 +13,26 @@ Provides access to various APIs related to file upload features.
|
||||
|
||||
### Methods
|
||||
|
||||
- **addToQueue**(files: [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`): [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`<br/>
|
||||
- **addToQueue**(files: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`): [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`<br/>
|
||||
Adds files to the uploading queue to be uploaded
|
||||
- _files:_ [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue
|
||||
- **Returns** [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list
|
||||
- **cancelUpload**(files: [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`)<br/>
|
||||
- _files:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files to queue
|
||||
- **Returns** [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - Array of files that were not blocked from upload by the ignore list
|
||||
- **cancelUpload**(files: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`)<br/>
|
||||
Cancels uploading of files. If the file is smaller than 1 MB the file will be uploaded and then the node deleted to prevent having files that were aborted but still uploaded.
|
||||
- _files:_ [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel
|
||||
- _files:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - One or more separate parameters or an array of files specifying uploads to cancel
|
||||
- **clearCache**()<br/>
|
||||
|
||||
- **clearQueue**()<br/>
|
||||
Clears the upload queue
|
||||
- **getQueue**(): [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]`<br/>
|
||||
- **getQueue**(): [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]`<br/>
|
||||
Gets the file Queue
|
||||
- **Returns** [`FileModel`](lib/core/src/lib/models/file.model.ts)`[]` - Array of files that form the queue
|
||||
- **Returns** [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)`[]` - Array of files that form the queue
|
||||
- **getThreadsCount**(): `number`<br/>
|
||||
Returns the number of concurrent threads for uploading.
|
||||
- **Returns** `number` - Number of concurrent threads (default 1)
|
||||
- **getUploadPromise**(file: [`FileModel`](lib/core/src/lib/models/file.model.ts)): `any`<br/>
|
||||
- **getUploadPromise**(file: [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)): `any`<br/>
|
||||
Gets an upload promise for a file.
|
||||
- _file:_ [`FileModel`](lib/core/src/lib/models/file.model.ts) - The target file
|
||||
- _file:_ [`FileModel`](../../../lib/core/src/lib/models/file.model.ts) - The target file
|
||||
- **Returns** `any` - [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises) that is resolved if the upload is successful or error otherwise
|
||||
- **isUploading**(): `boolean`<br/>
|
||||
Checks whether the service still has files uploading or awaiting upload.
|
||||
@@ -46,15 +46,15 @@ Provides access to various APIs related to file upload features.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ---- | ----------- |
|
||||
| queueChanged | [`FileModel`](lib/core/src/lib/models/file.model.ts)\[] | Emitted when the file queue changes. |
|
||||
| fileUpload | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a [File model](lib/core/src/lib/models/file.model.ts) changes its state. |
|
||||
| fileUploadStarting | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an upload starts. |
|
||||
| fileUploadCancelled | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an upload gets cancelled by the user. |
|
||||
| fileUploadProgress | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](lib/core/src/lib/models/file.model.ts). |
|
||||
| fileUploadAborted | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a file upload gets aborted by the server. |
|
||||
| fileUploadError | [`FileUploadEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an error occurs during a file upload. |
|
||||
| fileUploadComplete | [`FileUploadCompleteEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when a file upload is complete. |
|
||||
| fileUploadDelete | [`FileUploadDeleteEvent`](lib/core/src/lib/events/file.event.ts) | Emitted when an uploaded file is removed from server. |
|
||||
| queueChanged | [`FileModel`](../../../lib/core/src/lib/models/file.model.ts)\[] | Emitted when the file queue changes. |
|
||||
| fileUpload | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a [File model](lib/core/src/lib/models/file.model.ts) changes its state. |
|
||||
| fileUploadStarting | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an upload starts. |
|
||||
| fileUploadCancelled | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an upload gets cancelled by the user. |
|
||||
| fileUploadProgress | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted during the file upload process and contains the current progress for a particular [File model](lib/core/src/lib/models/file.model.ts). |
|
||||
| fileUploadAborted | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a file upload gets aborted by the server. |
|
||||
| fileUploadError | [`FileUploadEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when an error occurs during a file upload. |
|
||||
| fileUploadComplete | [`FileUploadCompleteEvent`](../../../lib/core/src/lib/events/file.event.ts) | Emitted when a file upload is complete. |
|
||||
| fileUploadDelete | [`FileUploadDeleteEvent`](../../../lib/core/src/lib/events/file.event.ts) | 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
|
||||
@@ -120,7 +120,7 @@ In this way all the files present in the .git folder won't be uploaded.
|
||||
|
||||
### Toggling Versioning Support
|
||||
|
||||
It is also possible to provide the `versioningEnabled` value as part of the [`FileUploadOptions`](lib/core/src/lib/models/file.model.ts) when using [upload service](../../core/services/upload.service.md) from the code.
|
||||
It is also possible to provide the `versioningEnabled` value as part of the [`FileUploadOptions`](../../../lib/core/src/lib/models/file.model.ts) when using [upload service](../../core/services/upload.service.md) from the code.
|
||||
|
||||
> Note: When creating a new node using multipart/form-data by default versioning is enabled and set to MAJOR Version.
|
||||
> Since Alfresco 6.2.3 versioningEnabled flag was introduced offering better control over the new node Versioning.
|
||||
|
||||
Reference in New Issue
Block a user