YouTrack Standalone 2017.2 Help

Sprint

Extends: BaseEntity

Represents a sprint that is associated with an agile board. Each sprint can include issues from one or more projects.

Properties

Name

Type

Description

Read-only

agile

Agile

The agile board that the sprint belongs to.

checkbox marked

becomesRemoved

Boolean

When `true`, the entity is removed in the current transaction. Otherwise, `false`.

checkbox marked

finish

Number

The end date of the sprint.

checkbox marked

isArchived

Boolean

If the sprint is currently archived, this property is `true`.

checkbox marked

isNew

Boolean

When `true`, the entity is created in the current transaction. Otherwise, `false`.

checkbox marked

name

String

The name of the sprint.

checkbox marked

start

Number

The start date of the sprint.

checkbox marked

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`.

 

isSwimlane

isSwimlane(issue)

Checks whether the specified issue is represented as a swimlane on the agile board that the sprint belongs to.

Parameters:

Name

Type

Description

issue

Issue

The issue to check.

Returns:

Type

Description

Boolean

If the specified issue is represented as a swimlane in the sprint, 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