alfresco-ng2-components/docs/process-attachment-list.component.md
Maurizio Vitale 18dc0711f9 [ADF-1711] Task Attachment list - Fix the TaskService dependency (#2752)
* Fix the TaskService dependency

* Improve doc and remove unused dep
2017-11-29 12:06:52 +00:00

45 lines
1.4 KiB
Markdown

# Process Attachment List component
Displays attached documents on a specified process instance
## Basic Usage
```html
<adf-process-attachment-list
[processInstanceId]="YOUR_PROCESS_INSTANCE_ID"
(attachmentClick)="YOUR_ATTACHMENT_CLICK_EMITTER_HANDLER">
</adf-process-attachment-list>
```
Make sure to override the UploadService with the ProcessUploadService
```ts
import { UploadService } from '@alfresco/adf-core';
import { ProcessUploadService } from '@alfresco/adf-process-services';
@Component({
selector: 'my-custom-process-attachment',
providers: [
{ provide: UploadService, useClass: ProcessUploadService }
]
})
export class MyCustomProcessAttachmentComponent {
constructor() {}
}
```
### Properties
| Name | Type | Description |
| --- | --- | -- |
| processInstanceId | string | | (**required**): The ID of the process instance to display |
| disabled | boolean | false | Disable/Enable read only mode for attachement list |
### Events
| Name | Description |
| --- | --- |
| attachmentClick | Raised when the attachment double clicked or selected view option from context menu by the user from within the component and return a Blob obj of the object clicker|
| success | Raised when the attachment list fetch all the attach and return a list of attachments |
| error | Raised when the attachment list is not able to fetch the attachments for example network error |