YouTrack Standalone 2018.1 Help

Agile

Represents an agile board and the set of sprints that belong to the board.

Extends BaseEntity.

Properties

NameTypeDescriptionRead-only
author User The user who created the board. checkbox marked
becomesRemoved Boolean When `true`, the entity is removed in the current transaction. Otherwise, `false`.

Available since 2017.4.37915

checkbox marked
isNew Boolean When `true`, the entity is created in the current transaction. Otherwise, `false`.

Available since 2018.2.42351

checkbox marked
name String The name of the agile board. checkbox marked
sprints Set.<Sprint> The set of sprints that are associated with the board. checkbox marked

Methods


findByName

static findByName(name)

Returns a set of agile boards that have the specified name.

Parameters

NameTypeDescription
name String The name of an agile board.

Return Value

TypeDescription
Set.<Agile> A set of agile boards that are assigned the specified name.

 

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

 

findSprintByName

findSprintByName(name)

Finds a specific sprint by name.

Parameters

NameTypeDescription
name String The name of the sprint.

Return Value

TypeDescription
Sprint If a sprint with the specified name is found, the corresponding Sprint object is returned. Otherwise, the return value is null.

 

getIssueSprints

getIssueSprints(issue)

Returns the sprints that an issue is assigned to on an agile board.

Available since 2018.1.39547

Parameters

NameTypeDescription
issue Issue The issue for which you want to get the sprints that it is assigned to.

Return Value

TypeDescription
Set.<Sprint> The sprints that the issue is assigned to on the agile board.

 

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 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: 31 May 2018