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 | | The agile board that the sprint belongs to. |  |
becomesRemoved | | When `true`, the entity is removed in the current transaction. Otherwise, `false`. | |
finish | | The end date of the sprint. | |
isArchived | | If the sprint is currently archived, this property is `true`. | |
isNew | | When `true`, the entity is created in the current transaction. Otherwise, `false`. | |
name | | The name of the sprint. | |
start | | The start date of the sprint. | |
Methods
becomes
becomes(fieldName, expected)Checks whether a field is set to an expected value in the current transaction.
Parameters:
Name | Type | Description |
|---|---|---|
fieldName | | The name of the field to check. |
expected | | The expected value. |
Returns:
Type | Description |
|---|---|
| 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 | | The name of the field. |
user | | The user for whom the permission to read the field is checked. |
Returns:
Type | Description |
|---|---|
| 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 | | The name of the field. |
user | | The user for whom the permission to update the field is checked. |
Returns:
Type | Description |
|---|---|
| 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 | | The name of the field to check. |
Returns:
Type | Description |
|---|---|
| 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 | | The issue to check. |
Returns:
Type | Description |
|---|---|
| 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 | | The name of the field. |
Returns:
Type | Description |
|---|---|
| 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 | | The name of the field to check. |
message | | The message that is displayed to the user that describes the field requirement. |