task-filter-cloud.service.md

Title	Added	Status	Last reviewed
Task Filter Cloud Service	v3.0.0	Experimental	2019-01-09

Task Filter Cloud Service

Manages task filters.

Class members

Methods

• addFilter(filter: TaskFilterCloudModel)
  Adds a new task filter.
  • filter: TaskFilterCloudModel - The new filter to add
• deleteFilter(filter: TaskFilterCloudModel)
  Deletes a task filter
  • filter: TaskFilterCloudModel - The filter to delete
• getCompletedTasksFilterInstance(appName: string): TaskFilterCloudModel
  Creates and returns a filter for "Completed" task instances.
  • appName: string - Name of the target app
  • Returns TaskFilterCloudModel - The newly created filter
• getMyTasksFilterInstance(appName: string): TaskFilterCloudModel
  Creates and returns a filter for "My Tasks" task instances.
  • appName: string - Name of the target app
  • Returns TaskFilterCloudModel - The newly created filter
• getTaskFilterById(appName: string, id: string): TaskFilterCloudModel
  Gets a task filter.
  • appName: string - Name of the target app
  • id: string - ID of the task
  • Returns TaskFilterCloudModel - Details of the task filter
• getTaskListFilters(appName?: string): Observable<TaskFilterCloudModel[]>
  Gets all task filters for a process app.
  • appName: string - (Optional) Name of the target app
  • Returns Observable<TaskFilterCloudModel[]> - Observable of task filter details
• getUsername(): string
  Gets the username field from the access token.
  • Returns string - Username string
• getValueFromToken(key: string)
  Gets a named value from the access token.
  • key: string - Key name of the value
• updateFilter(filter: TaskFilterCloudModel)
  Updates a task filter.
  • filter: TaskFilterCloudModel - The filter to update

Details

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

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

These filters can now be used to get matching task instances for the process app.

See also

• Task filter service