alfresco-ng2-components/docs/start-task.component.md

40 lines
800 B
Markdown

# Start Task Component
Creates/Starts new task for the specified app
![adf-start-task](docassets/images/adf-start-task.png)
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
<!-- toc -->
- [Basic Usage](#basic-usage)
* [Properties](#properties)
* [Events](#events)
<!-- tocstop -->
<!-- markdown-toc end -->
## Basic Usage
```html
<adf-start-task
[appId]="YOUR_APP_ID">
</adf-start-task>
```
### Properties
| Name | Type | Description |
| --- | --- | --- |
| appId | string | (**required**): The id of the app. |
### Events
| Name | Description |
| --- | --- |
| success | Raised when the task is successfully created |
| cancel | Raised when the cancel button is pressed by the user |
| error | Raised if there is an error during task creation |