YouTrack Standalone 2017.3 Help

State

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

Extends Field.

Properties

NameTypeDescriptionRead-only
static dateTimeType String Date and time field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static dateType String Date field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static fieldType String Field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static floatType String Float field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static integerType String Integer field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static periodType String Period field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
static stringType String String field type. Used when defining rule requirements. /help/img/youtrack/2017.3/checkbox-marked.png
backgroundColor String The background color of the value in the custom field as it is displayed in YouTrack. /help/img/youtrack/2017.3/checkbox-marked.png
colorIndex Number The index value of the color that is assigned to the value in the custom field. /help/img/youtrack/2017.3/checkbox-marked.png
description String The description of the value as visible in the administrative UI for custom fields. /help/img/youtrack/2017.3/checkbox-marked.png
foregroundColor String The foreground color of the value in the custom field as it is displayed in YouTrack. /help/img/youtrack/2017.3/checkbox-marked.png
isResolved Boolean If issues in this state are considered to be resolved, ths property is `true`. /help/img/youtrack/2017.3/checkbox-marked.png
name String The name of the value, which is also stored as the value in the custom field. /help/img/youtrack/2017.3/checkbox-marked.png
ordinal Number The position of the value in the set of values for the custom field. /help/img/youtrack/2017.3/checkbox-marked.png
presentation String String representation of the value. /help/img/youtrack/2017.3/checkbox-marked.png

Methods


becomes

becomes(fieldName, expected)

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

Parameters

NameTypeDescription
fieldName string The name of the field to check.
expected string The expected value.

Return Value

TypeDescription
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

NameTypeDescription
fieldName string The name of the field.
user User The user for whom the permission to read the field is checked.

Return Value

TypeDescription
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

NameTypeDescription
fieldName string The name of the field.
user User The user for whom the permission to update the field is checked.

Return Value

TypeDescription
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

NameTypeDescription
fieldName string The name of the field to check.

Return Value

TypeDescription
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

NameTypeDescription
fieldName string The name of the field.

Return Value

TypeDescription
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

NameTypeDescription
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: 17 October 2017