Task

Represents a Task resource object.

Parent class

Inherits from Array

Constructors

(string name "Name of the task", int Parent resource id "Resource id of the parent") - Creates a new task with the task name as description
(string name "Name of the task", int Parent resource id "Resource id of the parent", int? Task template "Resource id of the task template (0 for default)") - Creates a new task with the task name as description and a template
(string name "Name of the task", int Parent resource id "Resource id of the parent", string description "Description of the task") - Creates a new task with a custom description
(string name "Name of the task", int Parent resource id "Resource id of the parent", string description "Description of the task", int? Task template "Resource id of the task template (0 for default)") - Creates a new task with a custom description and a template

Methods

Empty Accept() - Accepts this task using the current user
Empty Accept(int User resource id "The user resource id") - Accepts this task as the specified user
Empty Approve() - Approves this task using the current user
Empty Approve(int User resource id "The user resource id") - Approves this task as the specified user
Empty Cancel(string Content "The cancellation reason") - Cancels this task using the current user
Empty Cancel(string Content "The cancellation reason", int User resource id "The user resource id") - Cancels this task as the specified user
Empty Disapprove(string Content "The disapproval comment") - Disapproves this task using the current user
Empty Disapprove(string Content "The disapproval comment", int User resource id "The user resource id") - Disapproves this task as the specified user
DateTime GetAcceptanceDeadline() - Returns the acceptance deadline of this task, or empty if not set
DateTime GetApprovalDeadline() - Returns the approval deadline of this task, or empty if not set
DateTime GetCompletionDeadline() - Returns the completion deadline of this task, or empty if not set
bool GetSendMailOnStatusChange() - Returns true if send-mail-on-status-change is enabled for this task
Empty Reassign(int Responsible resource id "The new responsible resource id", string Content "The reassignment comment") - Reassigns this task to a new responsible, using the current user
Empty Reassign(int Responsible resource id "The new responsible resource id", string Content "The reassignment comment", int User resource id "The acting user resource id") - Reassigns this task to a new responsible, acting as the specified user
Empty Reject(string Content "The rejection comment") - Rejects (or rejects a rejection of) this task using the current user
Empty Reject(string Content "The rejection comment", int User resource id "The user resource id") - Rejects (or rejects a rejection of) this task as the specified user
Empty Save() - Saves this task to the database
Empty SetAcceptanceDeadline() - Clears the acceptance deadline of this task
Empty SetAcceptanceDeadline(DateTime Acceptance Deadline "The acceptance deadline date") - Sets the acceptance deadline of this task
Empty SetApprovalDeadline() - Clears the approval deadline of this task
Empty SetApprovalDeadline(DateTime Approval Deadline "The approval deadline date") - Sets the approval deadline of this task
Empty SetCompleted(string Content "The completion comment") - Marks this task as completed using the current user
Empty SetCompleted(string Content "The completion comment", int User resource id "The user resource id") - Marks this task as completed as the specified user
Empty SetCompletionDeadline() - Clears the completion deadline of this task
Empty SetCompletionDeadline(DateTime Completion Deadline "The completion deadline date") - Sets the completion deadline of this task
Empty SetSendMailOnStatusChange() - Enables send-mail-on-status-change for this task (resets to default)
Empty SetSendMailOnStatusChange(bool Send mails "True to enable mails") - Sets send-mail-on-status-change for this task
Empty SetSupervisor(int supervisor resource unique id "The supervisor resource id") - Sets the supervisor of this task
string ToString() - The string representation of the object.
object this[] { get; }(int index "Index") - Backward-compatible indexer
Empty this[] { get; }(int index "Index", object value "Value to set") - Backward-compatible indexer

Properties

number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
int CaseNumber { get; } - The task case number
bool Completed { get; set; } - Whether the task is completed
bool CurrentUserIsResponsible { get; } - True if the current user is the responsible or a member of the responsible group
bool CurrentUserIsSupervisor { get; } - True if the current user is the supervisor or a member of the supervisor group
string Description { get; set; } - The task description
int ManHours { get; set; } - The number of man-hours logged
number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
string Name { get; set; } - The task name
string ObjectTypeName { get; } - The name of the type of object.
bool ObserverInheritAccess { get; set; } - Whether observers inherit access
array Observers { get; set; } - The list of observers for this task
int ParentResourceId { get; set; } - The parent resource id
int ResourceId { get; } - The task resource id
TaskParticipant Responsible { get; set; } - The responsible participant, or null if not set
int Status { get; } - The task status
number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
TaskParticipant Supervisor { get; set; } - The supervisor participant, or null if not set
int TemplateResourceId { get; } - The task template resource id
TaskTestcase Testcase { get; set; } - The test case assigned to this task, or null if none
bool TimeRegistration { get; } - Whether time registration is enabled
TypeInformation TypeInformation { get; } - Get information about this class.
int Version { get; } - The task object version

Static Methods

Empty Task_accept(int Task resource id "The task resource id") - Accepts the task using the current user
Empty Task_accept(int Task resource id "The task resource id", int? User resource id "The user resource id") - Accepts the task as the specified user
Empty Task_approve(int Task resource id "The task resource id") - Approves the task using the current user
Empty Task_approve(int Task resource id "The task resource id", int? User resource id "The user resource id") - Approves the task as the specified user
Empty Task_cancel(int Task resource id "The task resource id", string Content "The cancellation reason") - Cancels the task using the current user
Empty Task_cancel(int Task resource id "The task resource id", string Content "The cancellation reason", int? User resource id "The user resource id") - Cancels the task as the specified user
Empty Task_disapprove(int Task resource id "The task resource id", string Content "The disapproval comment") - Disapproves the task using the current user
Empty Task_disapprove(int Task resource id "The task resource id", string Content "The disapproval comment", int? User resource id "The user resource id") - Disapproves the task as the specified user
array Task_getAcceptanceDeadline(int Task resource id "The task resource id") - Returns the acceptance deadline of the task, or empty if not set
array Task_getApprovalDeadline(int Task resource id "The task resource id") - Returns the approval deadline of the task, or empty if not set
array Task_getCompletionDeadline(int Task resource id "The task resource id") - Returns the completion deadline of the task, or empty if not set
int? Task_getResourceUniqueIdFromTaskCaseNumber(int Task case number "The task case number") - Returns the resource unique id for the task with the given case number, or empty if not found
bool Task_getSendMailOnStatusChange(int Task resource id "The task resource id") - Returns true if send-mail-on-status-change is enabled for the task
Task Task_getTaskByCaseNumber(int Task case number "The task case number") - Returns the task with the given case number
Task Task_getTaskByResourceId(int Task resource id "The task resource id") - Returns the task with the given resource id
Array of Task Task_getTasksByParentResourceId(int Parent resource id "The parent resource id") - Returns all child tasks of the specified parent resource
Array of Task Task_getTasksByResourceIds(array Task resource id "Array of task resource ids") - Returns the tasks with the given resource ids
Empty Task_reassign(int Task resource id "The task resource id", int Responsible resource id "The new responsible resource id", string Content "The reassignment comment") - Reassigns the task to a new responsible, using the current user
Empty Task_reassign(int Task resource id "The task resource id", int Responsible resource id "The new responsible resource id", string Content "The reassignment comment", int? User resource id "The acting user resource id") - Reassigns the task to a new responsible, acting as the specified user
Empty Task_reject(int Task resource id "The task resource id", string Content "The rejection comment") - Rejects (or rejects a rejection of) the task using the current user
Empty Task_reject(int Task resource id "The task resource id", string Content "The rejection comment", int? User resource id "The user resource id") - Rejects (or rejects a rejection of) the task as the specified user
Empty Task_setAcceptanceDeadline(int Task resource id "The task resource id") - Clears the acceptance deadline of a task
Empty Task_setAcceptanceDeadline(int Task resource id "The task resource id", DateTime Acceptance Deadline "The acceptance deadline date") - Sets the acceptance deadline of a task
Empty Task_setApprovalDeadline(int Task resource id "The task resource id") - Clears the approval deadline of a task
Empty Task_setApprovalDeadline(int Task resource id "The task resource id", DateTime Approval Deadline "The approval deadline date") - Sets the approval deadline of a task
Empty Task_setCompleted(int Task resource id "The task resource id", string Content "The completion comment") - Marks the task as completed using the current user
Empty Task_setCompleted(int Task resource id "The task resource id", string Content "The completion comment", int? User resource id "The user resource id") - Marks the task as completed as the specified user
Empty Task_setCompletionDeadline(int Task resource id "The task resource id") - Clears the completion deadline of a task
Empty Task_setCompletionDeadline(int Task resource id "The task resource id", DateTime Completion Deadline "The completion deadline date") - Sets the completion deadline of a task
Empty Task_setSendMailOnStatusChange(int Task resource id "The task resource id") - Enables send-mail-on-status-change for the task (resets to default)
Empty Task_setSendMailOnStatusChange(int Task resource id "The task resource id", bool Send mails "True to enable mails") - Sets send-mail-on-status-change for the task
Empty Task_setSupervisor(int task unique id "The task resource id", int supervisor resource unique id "The supervisor resource id") - Sets the supervisor of a task