IssueWorkItem

Represents a work item that has been added to an issue.

Properties

Name	Type	Description
author	`User`	The user to whom the work is attributed in the work item.
created	`Number`	The date when the work item was created.
creator	`User`	The user who added the work item to the issue.
date	`Number`	The date and time that is assigned to the work item. Stored as a Unix timestamp in UTC.
description	`String`	The work item description.
duration	`Number`	The duration of the work item in minutes.
type	`WorkItemType`	The work item type.
updated	`Number`	The date when the work item was last updated.

Methods

becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
expected	`string`	The expected value.

Return Value

	Type	Description
	`boolean`	If the field is set to the expected value, returns `true`.

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to read the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can read the field, returns `true`.

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.
user	`User`	The user for whom the permission to update the field is checked.

Return Value

	Type	Description
	`boolean`	If the user can update the field, returns `true`.

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.

Return Value

	Type	Description
	`boolean`	If the value of the field is changed in the current transaction, returns `true`.

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, this value is equal to the current value of the field.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field.

Return Value

	Type	Description
	`Object`	previous If the field is changed in the current transaction, the previous value of the field. Otherwise, the current value of the field.

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

Name	Type	Description
fieldName	`string`	The name of the field to check.
message	`string`	The message that is displayed to the user that describes the field requirement.

Last modified: 7 March 2019