State

Extends: Field

Represents a value in a custom field that stores a state type.

Properties

Name	Type	Description
static dateTimeType	`String`	Date and time field type. Used when defining rule requirements.
static dateType	`String`	Date field type. Used when defining rule requirements.
static fieldType	`String`	Field type. Used when defining rule requirements.
static floatType	`String`	Float field type. Used when defining rule requirements.
static integerType	`String`	Integer field type. Used when defining rule requirements.
static periodType	`String`	Period field type. Used when defining rule requirements.
static stringType	`String`	String field type. Used when defining rule requirements.
static textType	`String`	Text field type. Used when defining rule requirements.
backgroundColor	`String`	The background color of the value in the custom field as it is displayed in YouTrack.
becomesRemoved	`Boolean`	When `true`, the entity is removed in the current transaction. Otherwise, `false`.
colorIndex	`Number`	The index value of the color that is assigned to the value in the custom field.
description	`String`	The description of the value as visible in the administrative UI for custom fields.
foregroundColor	`String`	The foreground color of the value in the custom field as it is displayed in YouTrack.
isNew	`Boolean`	When `true`, the entity is created in the current transaction. Otherwise, `false`.
isResolved	`Boolean`	If issues in this state are considered to be resolved, ths property is `true`.
name	`String`	The name of the value, which is also stored as the value in the custom field.
ordinal	`Number`	The position of the value in the set of values for the custom field.
presentation	`String`	String representation of the value.

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.

Returns:

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.

Returns:

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.

Returns:

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.

Returns:

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 changedin the transaction, returns null.

Parameters:

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

Returns:

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

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