Files
alfresco-ng2-components/docs/process-services-cloud/services/form-cloud.service.md
Andy Stark 921fdc00df [ADF-4391] Doc review for 3.2 (#4601)
* [ADF-4391] Reviewed new clipboard class docs

* [ADF-4391] Reviewed new proc cloud class docs

* [ADF-4391] Reviewed new datatable doc additions
2019-04-12 16:18:43 +01:00

6.0 KiB

Title, Added, Status, Last reviewed
Title Added Status Last reviewed
Form cloud service v3.2.0 Active 2019-04-12

Form cloud service

Implements Process Services form methods

Basic Usage

import { FormCloudService } from '@alfresco/adf-process-services-cloud';

@Component(...)
class MyComponent {

    constructor(formCloudService: FormCloudService) {}

}

Class members

Methods

  • completeTaskForm(appName: string, taskId: string, formId: string, formValues: FormValues, outcome: string): Observable<TaskDetailsCloudModel>
    Completes a task form.

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • formId: string - ID of the form to complete
    • formValues: FormValues - Form values object
    • outcome: string - (Optional) Form outcome
    • Returns Observable<TaskDetailsCloudModel> - Updated task details
  • createTemporaryRawRelatedContent(file: any, nodeId: any): Observable<any>

    • file: any -
    • nodeId: any -
    • Returns Observable<any> -
  • getForm(appName: string, taskId: string): Observable<any>
    Gets a form definition.

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • Returns Observable<any> - Form definition
  • getProcessStorageFolderTask(appName: string, taskId: string): Observable<any>

    • appName: string -
    • taskId: string -
    • Returns Observable<any> -
  • getTask(appName: string, taskId: string): Observable<TaskDetailsCloudModel>
    Gets details of a task

  • getTaskForm(appName: string, taskId: string): Observable<any>
    Gets the form definition of a task.

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • Returns Observable<any> - Form definition
  • getTaskVariables(appName: string, taskId: string): Observable<TaskVariableCloud[]>
    Gets the variables of a task.

  • parseForm(json: any, data?: TaskVariableCloud[], readOnly: boolean = false): FormCloud
    Parses JSON data to create a corresponding form.

    • json: any - JSON data to create the form
    • data: TaskVariableCloud[] - (Optional) (Optional) Values for the form's fields
    • readOnly: boolean - Toggles whether or not the form should be read-only
    • Returns FormCloud - Form created from the JSON specification
  • saveTaskForm(appName: string, taskId: string, formId: string, formValues: FormValues): Observable<TaskDetailsCloudModel>
    Saves a task form.

See also