YouTrack Standalone 2017.2 Help

Sprint

Extends: BaseEntity

Every sprint may contains issues from one project or from several projects.Sprint is a agile wrapper for project versionIf project version is shared between several projects, such sprint is a cross-project sprint.Sprint uses states from states bundle of associated agile.Content of particular sprint column (columns is associated with state) is: fix for: version state: column

Properties

NameTypeDescriptionRead-only
agile Agile Agile board the sprint belongs to. /help/img/youtrack/2017.2/checkbox-marked.png
finish Number End date of the sprint. /help/img/youtrack/2017.2/checkbox-marked.png
isArchived Boolean `true` in case the sprint is archived. /help/img/youtrack/2017.2/checkbox-marked.png
name String The name of the sprint. /help/img/youtrack/2017.2/checkbox-marked.png
start Number Start date of the sprint. /help/img/youtrack/2017.2/checkbox-marked.png

Methods

 

becomes

becomes(fieldName, expected)

Checks that a value a field receives in the current transaction is equal to an expected one.

Parameters:

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

Returns:

TypeDescription
boolean `true` in case the expectation is met.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks if a field can be read by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be read by the user.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks if a field can be written by a user.

Parameters:

NameTypeDescription
fieldName string name of the field.
user User to check access for.

Returns:

TypeDescription
boolean `true` in case the field can be written by the user.

 

isChanged

isChanged(fieldName)

Checks if a field is changed in the current transaction.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'summary') to check.

Returns:

TypeDescription
boolean `true` in case the field is changed in the current transaction.

 

isSwimlane

isSwimlane(issue)

Checks if the specified issue is a swimlane of the board the sprint belongs to.

Parameters:

NameTypeDescription
issue Issue Issue to check.

Returns:

TypeDescription
Boolean `true` in case the issue is a swimlane on the sprint's board.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-valued field before an update was applied. In case the field is not changedin the transaction, this value is equal to the current value of the field.

Parameters:

NameTypeDescription
fieldName string name of the field (e.g. 'updated') to get previous value of.

Returns:

TypeDescription
Object previous value of the field.

 

required

required(fieldName, message)

Checks if a the entity has a field denoted by field name set, shows error message otherwise.

Parameters:

NameTypeDescription
fieldName string name of the field to check.
message string message to show in case the field is not set.

 

Last modified: 9 August 2017