BaseArticle
The base class for article.
Extends BaseEntity.
Available since 2021.4.23500
Name | Type | Description |
|---|---|---|
attachments | Set.<BaseArticleAttachment> | Read-only. The set of attachments that are attached to the article. |
author | User | Read-only. The user who created the article. |
becomesRemoved | Boolean | Read-only. When `true`, the entity is removed in the current transaction. Otherwise, `false`. This property can become `true` only in on-change rules when the rule is triggered on the removal of an issue or an article. In the rule code, the `runOn` rule property must contain the `removal` parameter set to `true`. Available since 2017.4.37915 |
content | String | The text that is entered as the article content. |
isNew | Boolean | Read-only. When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 |
isStarred | Boolean | Read-only. If the current user has added the 'Star' tag to watch the article, this property is `true`. Available since 2023.1 |
summary | String | The article title. |
tags | Set.<Tag> | The list of tags that are attached to the article. Available since 2023.1 |
addTag(name)Adds a tag with the specified name to an article. YouTrack adds the first matching tag that is visible to the current user. If a match is not found, a new private tag is created for the current user.
Available since 2023.1
Parameters
Name | Type | Description |
|---|---|---|
name | String | The name of the tag to add to the article. |
Return Value
Type | Description |
|---|---|
Tag | The tag that has been added to the article. |
Example
article.addTag('review');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. |
Return Value
Type | Description |
|---|---|
boolean | If the field is set to the expected value, returns `true`. |
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. |
Return Value
Type | Description |
|---|---|
boolean | If the user can read the field, returns `true`. |
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. |
Return Value
Type | Description |
|---|---|
boolean | If the user can update the field, returns `true`. |
hasTag(tagName)Checks whether the specified tag is attached to the article.
Available since 2023.1
Parameters
Name | Type | Description |
|---|---|---|
tagName | String | The name of the tag to check for the article. |
Return Value
Type | Description |
|---|---|
Boolean | If the specified tag is attached to the article, returns `true`. |
is(fieldName, expected)Checks whether a field is equal to an expected value.
Available since 2019.2.55603
Parameters
Name | Type | Description |
|---|---|---|
fieldName | string | The name of the field to check. |
expected | string | The expected value. |
Return Value
Type | Description |
|---|---|
boolean | If the field is equal to the expected value, returns `true`. |
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. |
Return Value
Type | Description |
|---|---|
boolean | If the value of the field is changed in the current transaction, returns `true`. |
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, returns null.
Parameters
Name | Type | Description |
|---|---|---|
fieldName | string | The name of the field. |
Return Value
Type | Description |
|---|---|
Object | If the field is changed in the current transaction, the previous value of the field. Otherwise, null. |
removeTag(name)Removes a tag with the specified name from an article. If the specified tag is not attached to the article, nothing happens. This method first searches through tags owned by the current user, then through all other visible tags.
Available since 2023.1
Parameters
Name | Type | Description |
|---|---|---|
name | String | The name of the tag to remove from the article. |
Return Value
Type | Description |
|---|---|
Tag | The tag that has been removed from the article. |
Example
article.removeTag('waiting for review');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. |
was(fieldName, expected)Checks whether a field was equal to an expected value prior to the current transaction.
Available since 2019.2.55603
Parameters
Name | Type | Description |
|---|---|---|
fieldName | string | The name of the field to check. |
expected | string | The expected value. |
Return Value
Type | Description |
|---|---|
boolean | If the field was equal to the expected value, returns `true`. |