YouTrack InCloud 2017.2 Help

Agile

Extends: BaseEntity

Stores settings for set of sprints.

Properties

NameTypeDescriptionRead-only
author User The user who created the board. /help/img/youtrack/2017.2/checkbox-marked.png
name String Name of the board /help/img/youtrack/2017.2/checkbox-marked.png
sprints Set.<Sprint> The sprints created for the board. /help/img/youtrack/2017.2/checkbox-marked.png

Methods

 

findByName

static findByName(name)

Returns Agiles that have the specified name.

Parameters:

NameTypeDescription
name String The name to find by.

Returns:

TypeDescription
Set.<Agile> Agiles found by the specified name.

 

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.

 

findSprintByName

findSprintByName(name)

Finds a sprint of the board with a given name.

Parameters:

NameTypeDescription
name String Sprint name.

Returns:

TypeDescription
Sprint Sprint or null.

 

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.

 

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