tasks library

The v4 tasks family: its endpoints, bound class, path templates and views.

Import it with a prefix, import 'package:exsited/tasks.dart' as tasks;, because families declare the same top-level names and a Dart export can neither rename nor prefix them.

Classes

Task

The task body.

TaskChecklist

What getTaskChecklist answers, under work_task.

TaskCompletedBy

A Task's completed_by.

TaskCreatedBy

A Task's created_by.

TaskLastUpdatedBy

A Task's last_updated_by.

TaskList

A page of Task records.

TaskNoteList

One page of what getTaskNotes lists, under data.

TasksResource

The tasks endpoints with client already applied.

TasksUrls

TaskView

What getTask answers, under work_task.

TaskViewActivityLog

One entry of a TaskView's activity_logs.

TaskViewAssignees

A TaskView's assignees.

TaskViewAssigneesSelectedEmployee

One entry of a TaskViewAssignees's selected_employees.

TaskViewAssigneesSelectedLabour

One entry of a TaskViewAssignees's selected_labours.

TaskViewChecklist

One entry of a TaskView's checklist.

TaskViewCompletedBy

A TaskView's completed_by.

TaskViewCreatedBy

A TaskView's created_by.

TaskViewLastUpdatedBy

A TaskView's last_updated_by.

Functions

createTask(ExsitedClient client, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskView>>

POST /api/{api_version}/tasks

createTaskChecklist(ExsitedClient client, Object taskId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskView>>

POST /api/{api_version}/tasks/{task_id}/checklist

createTaskNote(ExsitedClient client, Object taskId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

POST /api/{api_version}/tasks/{task_code}/notes

deleteTask(ExsitedClient client, Object taskId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/tasks/{task_id}

deleteTaskChecklistByUuid(ExsitedClient client, Object taskId, Object taskChecklistUuid, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/tasks/{task_id}/checklist/{task_checklist_uuid}

deleteTaskNote(ExsitedClient client, Object taskId, Object taskNoteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/tasks/{task_code}/notes/{note_id}

deleteTaskNoteFile(ExsitedClient client, Object taskCode, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

DELETE /api/{api_version}/tasks/{task_code}/notes/{note_id}/files/{file_id}

getTask(ExsitedClient client, Object taskId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskView>>

GET /api/{api_version}/tasks/{task_id}

getTaskChecklist(ExsitedClient client, Object taskId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskChecklist>>

GET /api/{api_version}/tasks/{task_id}/checklist

getTaskChecklistByUuid(ExsitedClient client, Object taskId, Object taskChecklistUuid, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskChecklist>>

GET /api/{api_version}/tasks/{task_id}/checklist/{task_checklist_uuid}

getTaskNote(ExsitedClient client, Object taskCode, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/tasks/{task_code}/notes/{note_id}

getTaskNoteFile(ExsitedClient client, Object taskCode, Object noteId, Object fileId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/tasks/{task_code}/notes/{note_id}/files/{file_id}

getTaskNoteFiles(ExsitedClient client, Object taskCode, Object noteId, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

GET /api/{api_version}/tasks/{task_code}/notes/{note_id}/files

getTaskNotes(ExsitedClient client, Object taskId, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskNoteList>>

GET /api/{api_version}/tasks/{task_code}/notes

getTasks(ExsitedClient client, {Map<String, Object?>? queryParams, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskList>>

GET /api/{api_version}/tasks

updateTask(ExsitedClient client, Object taskId, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskView>>

PATCH /api/{api_version}/tasks/{task_id}

updateTaskChecklistByUuid(ExsitedClient client, Object taskId, Object taskChecklistUuid, Object payload, {bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<TaskView>>

PATCH /api/{api_version}/tasks/{task_id}/checklist/{task_checklist_uuid}

updateTaskNote(ExsitedClient client, Object taskCode, Object noteId, String note, {Map<String, Object?>? files, bool? raiseOnError, String? responseFormat}) → Future<ApiResponse<Object?>>

PATCH /api/{api_version}/tasks/{task_code}/notes/{note_id}