Skip to content

Latest commit

 

History

History
97 lines (79 loc) · 6.98 KB

form-cloud.service.md

File metadata and controls

97 lines (79 loc) · 6.98 KB
Raw
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, processInstanceId: string, formId: string, formValues: FormValues, outcome: string, version: number): Observable<TaskDetailsCloudModel>
    Completes a task form.

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • processInstanceId: string - ID of processInstance
    • formId: string - ID of the form to complete
    • formValues: FormValues - Form values object
    • outcome: string - Form outcome
    • version: number - of the form
    • Returns Observable<TaskDetailsCloudModel> - Updated task details

  • createTemporaryRawRelatedContent(file: any, nodeId: string, contentHost: string): Observable<any>

    • file: any -
    • nodeId: string -
    • contentHost: string -
    • Returns Observable<any> -

  • getBasePath(appName: string): string

    • appName: string -
    • Returns string -

  • getForm(appName: string, formKey: string, version?: number): Observable<FormContent>
    Gets a form definition.

    • appName: string - Name of the app
    • formKey: string - key of the target task
    • version: number - (Optional) Version of the form
    • Returns Observable<FormContent> - Form definition

  • getRestWidgetData(formName: string, widgetId: string, body: any = {}): Observable<FormFieldOption[]>

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

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

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • version: number - (Optional) Version of the form
    • 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): FormModel
    Parses JSON data to create a corresponding form.

    • json: any - JSON data to create the form
    • data: TaskVariableCloud[] - (Optional) Values for the form's fields
    • readOnly: boolean - Toggles whether or not the form should be read-only
    • Returns FormModel - Form created from the JSON specification

  • saveTaskForm(appName: string, taskId: string, processInstanceId: string, formId: string, values: FormValues): Observable<TaskDetailsCloudModel>
    Saves a task form.

    • appName: string - Name of the app
    • taskId: string - ID of the target task
    • processInstanceId: string - ID of processInstance
    • formId: string - ID of the form to save
    • values: FormValues - Form values object
    • Returns Observable<TaskDetailsCloudModel> - Updated task details

See also