YouTrack および Hub ヘルプの開発者ポータル

Article

YouTrack の記事を表します。

BaseArticle を拡張します。

2021.4.23500 から利用可能

Properties

名前

タイプ

説明

添付

Set。<BaseArticleAttachment>

読み取り専用。記事に添付される添付ファイルのセット。

作成者

ユーザー

読み取り専用。記事を作成したユーザー。

削除される

Boolean

読み取り専用。`true` の場合、エンティティは現在のトランザクションで削除されます。それ以外の場合は `false` です。このプロパティは、課題または記事の削除時にルールがトリガーされるときに、変更時ルールでのみ `true` になることができます。ルールコードでは、`runOn` ルールプロパティに `true` に設定された `removal` パラメーターが含まれている必要があります。

2017.4.37915 から利用可能

runOn: {removal: true}

childArticles

セットします。<Article>

現在の記事のサブ記事のセット。

2024.4 から利用可能

コメント

Set.<記事コメント>

読み取り専用。記事に対するコメントのリスト。

コンテンツ

文字列

記事の内容として入力されるテキスト。

作成しました

番号

読み取り専用。記事が作成された日付。

編集されたコメント

Set.<記事コメント>

読み取り専用。現在のトランザクションで編集されたコメントのセット。追加および削除されたコメントは編集されたとみなされません。代わりに、これらは `article.comments.added` プロパティと `article.comments.removed` プロパティによって表されます。

拡張機能プロパティ

オブジェクト

このエンティティの拡張プロパティとその値を含むオブジェクト。拡張プロパティは、アプリによってコア YouTrack エンティティに追加される可能性のあるカスタムプロパティです。拡張プロパティの詳細については、https://www.jetbrains.com/help/youtrack/devportal/apps-extension-properties.html を参照してください。

2024.3 から利用可能

const entities = require('@jetbrains/youtrack-scripting-api/entities'); exports.rule = entities.Issue.action({ command: 'test', action: function (ctx) { const printValues = () => { return 'stringProp:' + ctx.issue.extensionProperties.stringProp + ';' + 'integerProp:' + ctx.issue.extensionProperties.integerProp + ';' + 'booleanProp:' + ctx.issue.extensionProperties.booleanProp + ';' + 'issueProp:' + ctx.issue.extensionProperties.issueProp?.id + ';' + 'issuesProp:' + ctx.issue.extensionProperties.issuesProp?.first()?.id + ';' } ctx.issue.addComment(printValues()); } });

id

文字列

読み取り専用。記事 ID。

新規

Boolean

読み取り専用。true の場合、エンティティは現在のトランザクションで作成されます。そうでなければ、`false` です。

2018.2.42351 から利用可能

スター付き

Boolean

読み取り専用。現在のユーザーが記事をウォッチするために「スター」を追加している場合、このプロパティは `true` になります。

2023.1 から利用可能

numberInProject

番号

読み取り専用。プロジェクトの記事番号。

オリジナル記事

論文

読み取り専用。現在の記事の草稿が作成された元の記事、または現在の記事が草稿でない場合は「null」。

2026.1 から利用可能

parentArticle

論文

現在の記事の親記事。

2024.4 から利用可能

許可されたグループ

Set。<UserGroup>

表示が複数のグループに制限されている場合に、記事が表示されるグループ。

2026.1 から利用可能

許可されたユーザー

Set。<ユーザー>

記事を閲覧できるユーザーのリスト。

2026.1 から利用可能

固定コメント

Set.<記事コメント>

読み取り専用。記事に固定されているコメントのセット。

2024.1 から利用可能

プロジェクト

プロジェクト

記事が割り当てられているプロジェクト。

概要

文字列

記事のタイトル。

タグ

設定します。<タグ>

記事に付けられたタグの一覧です。

2023.1 から利用可能

更新日

番号

読み取り専用。記事が最後に更新された日付。

updateBy

ユーザー

読み取り専用。記事を最後に更新したユーザー。

URL

文字列

読み取り専用。記事を指す絶対 URL。

2025.1 から利用可能

コンストラクター

Article

Article(author, project, summary)

2021.4.23500 から利用可能

パラメーター

名前

タイプ

説明

作成者

ユーザー、JsonForArticleConstructor

記事の作成者。または、 JsonForArticleConstructor で指定された JSON を渡します

プロジェクト

プロジェクト

新しい記事が作成されるプロジェクト。

概要

文字列

記事のタイトル。

メソッド

action

static action(ruleProperties)

ユーザーがメニューオプションを使用して記事に適用できるルールの宣言を作成します。このメソッドによって返されるオブジェクトは通常、`rule` プロパティにエクスポートされますが、それ以外の場合はルールとして扱われません。

パラメーター

名前

タイプ

説明

ルールプロパティ

オブジェクト

ルールのプロパティを定義する JSON オブジェクト。

ルールのプロパティ

名前

タイプ

説明

タイトル

文字列

人間が判読できるルールの名前。YouTrack の管理 UI に表示されます。

ユーザー入力

オブジェクト

アクションルールをトリガーするユーザーから要求される情報のプロパティを定義するオブジェクト。

userInput.type

文字列、オブジェクト

ユーザーから要求された値のデータ型。次のタイプがサポートされています。ビルド * エンティティ .EnumField * エンティティ .Issue * エンティティ .IssueTag * エンティティ .OwnedField * エンティティ . プロジェクト * エンティティ .ProjectVersion * エンティティ . ユーザーグループ * エンティティ . ユーザー

userInput.description

文字列

ユーザーから追加情報を収集するために使用されるコントロールのラベル。

ガード

記事 ~ ガード関数

アクションが記事に適用可能かどうかを判断するために呼び出される関数。

アクション

記事 ~ アクション関数

ユーザーがこのアクションをトリガーしたときに呼び出される関数。

要件

要件

スクリプトが期待どおりに機能するために存在する必要があるエンティティのセット。

戻り値

タイプ

説明

オブジェクト

ルールのオブジェクト表現。

サンプル

var entities = require('@jetbrains/youtrack-scripting-api/entities'); exports.rule = entities.Article.action({ title: 'Log article comments', command: 'log', guard: function(ctx) { return ctx.article.comments.isEmpty(); }, action: function(ctx) { ctx.article.comments.forEach(function(comment) { console.log(comment.text); }); } });

createDraft

static createDraft(project, author)

新しい記事の下書きを作成します。

パラメーター

名前

タイプ

説明

プロジェクト

プロジェクト

新しい記事の草稿が作成されるプロジェクト。

作成者

ユーザー

記事草稿の作成者。

戻り値

タイプ

説明

ArticleDraft

新たに作成された記事の草稿。

findByExtensionProperties

static findByExtensionProperties(extensionPropertiesQuery)

指定されたクエリに一致する拡張プロパティを持つ Article エンティティを検索します。

2024.3.43260 から利用可能

パラメーター

名前

タイプ

説明

拡張機能プロパティクエリ

オブジェクト

拡張プロパティクエリは、プロパティとそれに対応する値を表すキーと値のペアのセットとして定義されます。

戻り値

タイプ

説明

セットします。<Article>

指定された拡張プロパティを含む Article エンティティのセット。

サンプル

{ property1: "value1", property2: "value2" }

findById

static findById(id)

表示されている ID で記事を検索します。

パラメーター

名前

タイプ

説明

id

文字列

記事 ID。

戻り値

タイプ

説明

論文

指定された ID が割り当てられている記事。

onChange

static onChange(ruleProperties)

記事に変更が適用されたときにトリガーされるルールの宣言を作成します。このメソッドによって返されるオブジェクトは通常、`rule` プロパティにエクスポートされますが、それ以外の場合はルールとして扱われません。

パラメーター

名前

タイプ

説明

ルールプロパティ

オブジェクト

ルールのプロパティを定義する JSON オブジェクト。

ルールのプロパティ

名前

タイプ

説明

タイトル

文字列

人間が判読できるルールの名前。YouTrack の管理 UI に表示されます。

ガード

記事 ~ ガード関数

ルールを実行するための条件を決定する関数。ガード条件が満たされない場合、ルールで指定されたアクションは記事に適用されません。

アクション

記事 ~ アクション関数

記事の変更時に呼び出される関数。

要件

要件

スクリプトが期待どおりに機能するために存在する必要があるエンティティのセット。

runOn

オブジェクト

変更時ルールをトリガーする記事イベントを決定します。指定しない場合は、記事の変更時にルールがトリガーされます。

runOn.change

boolean

`true` の場合、記事の変更時にルールがトリガーされます。

runOn.removal

boolean

`true` の場合、記事が論理的に削除されたときにルールがトリガーされます。

戻り値

タイプ

説明

オブジェクト

ルールのオブジェクト表現。

サンプル

var entities = require('@jetbrains/youtrack-scripting-api/entities'); exports.rule = entities.Article.onChange({ title: 'On article change, log its ID', action: function(ctx) { console.log(ctx.article.id); } });

addAttachment

addAttachment(content, name, charset, mimeType)

記事にファイルを添付します。現在のトランザクションで `article.attachments.isChanged` が `true` を返すようにします。

2020.2 から利用可能

パラメーター

名前

タイプ

説明

コンテンツ

入力ストリーム、文字列、JsonForArticleAddAttachment

バイナリ形式または base64 形式のファイルの内容。または、 JsonForArticleAddAttachment で指定された JSON を渡します

名前

文字列

ファイルの名前。

文字コード

文字列

ファイルの文字セット。テキストファイルにのみ適用されます。

mimeType

文字列

ファイルの MIME タイプ。

戻り値

タイプ

説明

ArticleAttachment

記事に追加される添付ファイル。

addComment

addComment(text, author)

記事にコメントを追加します。

パラメーター

名前

タイプ

説明

テキスト

文字列、JsonForArticleAddComment

コメントとして記事に追加するテキスト。または、 JsonForArticleAddComment で指定された JSON を渡します

作成者

ユーザー

コメントの作成者。

戻り値

タイプ

説明

ArticleComment

新しく作成されたコメント。

addTag

addTag(name)

指定した名前のタグを記事に追加します。YouTrack は、現在のユーザーに表示される最初に一致するタグを追加します。一致するものが見つからない場合は、現在のユーザーに対して新しいプライベートタグが作成されます。

2023.1 から利用可能

パラメーター

名前

タイプ

説明

名前

文字列

記事に追加するタグの名前。

戻り値

タイプ

説明

タグ

記事に付けられたタグです。

サンプル

article.addTag('review');

becomes

becomes(fieldName, expected)

現在のトランザクションでフィールドが期待値に設定されているかどうかを確認します。

パラメーター

名前

タイプ

説明

フィールド名

文字列

確認するフィールドの名前。

が必要です

文字列

期待値

戻り値

タイプ

説明

boolean

フィールドが期待値に設定されている場合、`true` を返します。

canBeReadBy

canBeReadBy(fieldName, user)

ユーザーにフィールドの読み取り権限があるかどうかを確認します。

パラメーター

名前

タイプ

説明

フィールド名

文字列

フィールドの名前

ユーザー

ユーザー

フィールドを読み取る許可がチェックされているユーザー。

戻り値

タイプ

説明

boolean

ユーザがフィールドを読むことができるなら、`true` を返します。

canBeWrittenBy

canBeWrittenBy(fieldName, user)

ユーザーにフィールドを更新する権限があるかどうかを確認します。

パラメーター

名前

タイプ

説明

フィールド名

文字列

フィールドの名前

ユーザー

ユーザー

フィールドを更新する権限がチェックされているユーザー。

戻り値

タイプ

説明

boolean

ユーザがフィールドを更新できる場合、`true` を返します。

hasTag

hasTag(tagName)

指定したタグが記事に付与されているかどうかを確認します。

2023.1 から利用可能

パラメーター

名前

タイプ

説明

タグ名

文字列

記事をチェックするタグの名前。

戻り値

タイプ

説明

Boolean

指定したタグが記事に付いている場合は「true」を返します。

is

is(fieldName, expected)

フィールドが期待値と等しいかどうかを確認します。

2019.2.55603 から利用可能

パラメーター

名前

タイプ

説明

フィールド名

文字列

確認するフィールドの名前。

が必要です

文字列

期待値

戻り値

タイプ

説明

boolean

フィールドが期待値と等しい場合、`true` を返します。

isChanged

isChanged(fieldName)

現在のトランザクションでフィールドの値が変更されたかどうかを確認します。

パラメーター

名前

タイプ

説明

フィールド名

文字列

確認するフィールドの名前。

戻り値

タイプ

説明

boolean

現在のトランザクションでフィールドの値が変更された場合、`true` を返します。

oldValue

oldValue(fieldName)

更新が適用される前の単一値フィールドの前の値を返します。トランザクション内でフィールドが変更されていない場合は、null を返します。

パラメーター

名前

タイプ

説明

フィールド名

文字列

フィールドの名前

戻り値

タイプ

説明

オブジェクト

現在のトランザクションでフィールドが変更された場合は、そのフィールドの以前の値。そうでない場合は null

removeTag

removeTag(name)

指定された名前のタグを記事から削除します。指定したタグが記事に付加されていない場合は何も起こりません。このメソッドは、まず現在のユーザーが所有するタグを検索し、次に他のすべての表示可能なタグを検索します。

2023.1 から利用可能

パラメーター

名前

タイプ

説明

名前

文字列

記事から削除するタグの名前。

戻り値

タイプ

説明

タグ

記事から削除されたタグ。

サンプル

article.removeTag('waiting for review');

required

required(fieldName, message)

フィールドに値が設定されていることを表明します。必須フィールドの値が設定されていない場合は、指定されたメッセージがユーザーインターフェースに表示されます。

パラメーター

名前

タイプ

説明

フィールド名

文字列

確認するフィールドの名前。

メッセージ

文字列

フィールド要件を説明する、ユーザーに表示されるメッセージ。

was

was(fieldName, expected)

フィールドが現在のトランザクションの前の期待値と等しいかどうかを確認します。

2019.2.55603 から利用可能

パラメーター

名前

タイプ

説明

フィールド名

文字列

確認するフィールドの名前。

が必要です

文字列

期待値

戻り値

タイプ

説明

boolean

フィールドが期待値と等しい場合、`true` を返します。

2026 年 7 月 06 日
AppGlobalStorage ArticleAttachment