Skip to content

Latest commit

 

History

History
112 lines (95 loc) · 5.58 KB

task-filter.service.md

File metadata and controls

112 lines (95 loc) · 5.58 KB
Raw
Title Added Status Last reviewed
Task Filter Service
v2.0.0
Active
2018-06-07

Task Filter Service

Manage Task Filters, which are pre-configured Task Instance queries.

Class members

Methods

  • addFilter(filter: UserTaskFilterRepresentation): Observable<UserTaskFilterRepresentation>
    Adds a new task filter
    • filter: UserTaskFilterRepresentation - The new filter to add
    • Returns Observable<UserTaskFilterRepresentation> - Details of task filter just added
  • callApiTaskFilters(appId?: number): Promise<any>
    Calls getUserTaskFilters from the Alfresco JS API.
    • appId: number - (Optional) ID of the target app
    • Returns Promise<any> - List of task filters
  • createDefaultFilters(appId: number): Observable<UserTaskFilterRepresentation>[]>
    Creates and returns the default filters for a process app.
    • appId: number - ID of the target app
    • Returns Observable<UserTaskFilterRepresentation>[]> - Array of default filters just created
  • getCompletedTasksFilterInstance(appId: number, index?: number): UserTaskFilterRepresentation
    Creates and returns a filter for "Completed" task instances.
    • appId: number - ID of the target app
    • index: number - (Optional) of the filter (optional)
    • Returns UserTaskFilterRepresentation - The newly created filter
  • getInvolvedTasksFilterInstance(appId: number, index?: number): UserTaskFilterRepresentation
    Creates and returns a filter for "Involved" task instances.
    • appId: number - ID of the target app
    • index: number - (Optional) of the filter (optional)
    • Returns UserTaskFilterRepresentation - The newly created filter
  • getMyTasksFilterInstance(appId: number, index?: number): UserTaskFilterRepresentation
    Creates and returns a filter for "My Tasks" task instances.
    • appId: number - ID of the target app
    • index: number - (Optional) of the filter (optional)
    • Returns UserTaskFilterRepresentation - The newly created filter
  • getQueuedTasksFilterInstance(appId: number, index?: number): UserTaskFilterRepresentation
    Creates and returns a filter for "Queued Tasks" task instances.
    • appId: number - ID of the target app
    • index: number - (Optional) of the filter (optional)
    • Returns UserTaskFilterRepresentation - The newly created filter
  • getTaskFilterById(filterId: number, appId?: number): Observable<UserTaskFilterRepresentation>
    Gets a task filter by ID.
    • filterId: number - ID of the filter
    • appId: number - (Optional) ID of the app for the filter
    • Returns Observable<UserTaskFilterRepresentation> - Details of task filter
  • getTaskFilterByName(taskName: string, appId?: number): Observable<UserTaskFilterRepresentation>
    Gets a task filter by name.
    • taskName: string - Name of the filter
    • appId: number - (Optional) ID of the app for the filter
    • Returns ObservableUserTaskFilterRepresentation> - Details of task filter
  • getTaskListFilters(appId?: number): UserTaskFilterRepresentation[]>
    Gets all task filters for a process app.
    • appId: number - (Optional) Optional ID for a specific app
    • Returns Observable<UserTaskFilterRepresentation[]> - Array of task filter details

Details

The methods of this service generally return an instance of UserTaskFilterRepresentation or an array of instances. For example, you could use getTaskListFilters as follows:

const processAppId = 2;

this.taskFilterService.getTaskListFilters(processAppId).subscribe(
    (filters: UserTaskFilterRepresentation[]) => {
      console.log('Task filters: ', filters);
    }, 
    (error) => {
      console.log('Error: ', error);
  }
);

The response is an array of UserTaskFilterRepresentation objects:

    filters:  
        0: {id: 10, appId: 2, name: "Involved Tasks", recent: true, icon: "glyphicon-align-left", …}
        1: {id: 9, appId: 2, name: "My Tasks", recent: false, icon: "glyphicon-inbox", …}
        2: {id: 11, appId: 2, name: "Queued Tasks", recent: false, icon: "glyphicon-record", …}
        3: {id: 12, appId: 2, name: "Completed Tasks", recent: false, icon: "glyphicon-ok-sign", …}
        4: {id: 4004, appId: 2, name: "Completed Tasks", recent: false, icon: "glyphicon-ok-sign", …}
        5: {id: 4005, appId: 2, name: "My Tasks", recent: false, icon: "glyphicon-inbox", …}
        6: {id: 4006, appId: 2, name: "Queued Tasks", recent: false, icon: "glyphicon-record", …}
        7: {id: 4007, appId: 2, name: "Involved Tasks", recent: false, icon: "glyphicon-align-left", …}

These filters can now be used to get matching task instances for the process app with ID 2, such as 'Involved Tasks', 'My Tasks', 'Queued Tasks', and 'Completed Tasks'.

Importing

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

export class SomePageComponent implements OnInit {
    constructor(private taskFilterService: TaskFilterService) {
    }
}

See also