Project
Represents a YouTrack project.
Extends BaseEntity.
Properties
Methods
findByKey
static findByKey(key)
Finds a project by ID.
Name | Type | Description |
---|---|---|
key | String | The ID of the project to search for. |
Type | Description | |
---|---|---|
Project | The project, or null when there are no projects with the specified ID. |
findByName
static findByName(name)
Finds a project by name.
Name | Type | Description |
---|---|---|
name | String | The name of the project to search for. |
Type | Description | |
---|---|---|
Project | The project, or null when there are no projects with the specified name. |
becomes
becomes(fieldName, expected)
Checks whether a field is set to an expected value in the current transaction.
Name | Type | Description |
---|---|---|
fieldName | string | The name of the field to check. |
expected | string | The expected value. |
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.
Name | Type | Description |
---|---|---|
fieldName | string | The name of the field. |
user | User | The user for whom the permission to read the field is checked. |
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.
Name | Type | Description |
---|---|---|
fieldName | string | The name of the field. |
user | User | The user for whom the permission to update the field is checked. |
Type | Description | |
---|---|---|
boolean | If the user can update the field, returns `true`. |
findFieldByName
findFieldByName(name)
Returns the custom field in the project with the specified name.
Name | Type | Description |
---|---|---|
name | String | The name of the custom field. |
Type | Description | |
---|---|---|
ProjectCustomField | The custom field with the specified name. |
intervalToWorkingMinutes
intervalToWorkingMinutes(start, end)
Gets the number of minutes that occurred during working hours in a specified interval. For example, if the interval is two days and the number of working hours in a day is set to 8, the result is 2 * 8 * 60 = 960
Name | Type | Description |
---|---|---|
start | Number | Start of the interval. |
end | Number | End of the interval. |
Type | Description | |
---|---|---|
Number | The number of minutes that occurred during working hours in the specified interval. |
isChanged
isChanged(fieldName)
Checks whether the value of a field is changed in the current transaction.
Name | Type | Description |
---|---|---|
fieldName | string | The name of the field to check. |
Type | Description | |
---|---|---|
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.
Name | Type | Description |
---|---|---|
fieldName | string | The name of the field. |
Type | Description | |
---|---|---|
Object | previous 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.
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. |