IWorkItemFormService interface

パッケージ:

azure-devops-extension-api

現在アクティブな作業項目フォーム (現在 UI に表示されている作業項目) と対話するためのホスト サービス。 フォーム サービスは、現在アクティブな作業項目のコンテキストによって異なります。 開いている作業項目がない場合にエラーをスローします。

メソッド

addWorkItemRelations(WorkItemRelation[])	別の作業項目または成果物 (コミット、ハイパーリンクなど) のリンクを作業項目に追加します。 添付ファイルは現在、この関数ではサポートされていません。
beginSaveWorkItem(() => void, () => void)	@deprecated: 保存を使用してください
clearError()	setError メソッドによって設定されたエラーをクリアし、フォーム内の作業項目の保存のブロックを解除します。
getAllowedFieldValues(string)	作業中の作業項目のフィールドに使用できる値を取得します。
getDirtyFields(boolean)	ユーザーまたは作業項目ルールによって変更され、ダーティ状態のフィールドを取得します。
getFields()	アクティブな作業項目フィールドを取得します。
getFieldValue(string, boolean)	アクティブな作業項目のフィールド値を取得します。
getFieldValue(string, WorkItemOptions)	アクティブな作業項目のフィールド値を取得します。
getFieldValues(string[], boolean)	アクティブな作業項目のフィールド値を取得します。
getFieldValues(string[], WorkItemOptions)	アクティブな作業項目のフィールド値を取得します。
getId()	アクティブな作業項目の ID を取得します。
getIdentityFieldValue(string, WorkItemOptions)	アクティブな作業項目の ID フィールド値を取得します。
getInvalidFields()	作業項目ルールに従って無効な状態のフィールドを取得します。 これらのフィールドは、作業項目を保存する前に変更する必要があります。
getRevision()	アクティブな作業項目の最新のリビジョンを取得します。
getWorkItemRelations()	他の作業項目または成果物 (コミット、ハイパーリンクなど) への作業項目リンクの配列を返します。 添付ファイルは現在、この関数ではサポートされていません。
getWorkItemRelationTypes()	作業項目のリレーションシップ型の配列を返します。
getWorkItemResourceUrl(number)	指定した作業項目リソースの REST API URL を返します。
hasActiveWorkItem()	作業中の作業項目が使用可能な場合は true を返します。
isDirty()	作業中の作業項目がダーティ場合は true を返します。
isNew()	作業中の作業項目が新しい場合は true を返します。
isValid()	作業中の作業項目フィールドがすべて有効な場合は true を返します。
refresh()	アクティブな作業項目を更新します。 作業項目がダーティされている場合は、ユーザーにメッセージが表示されます。
removeWorkItemRelations(WorkItemRelation[])	別の作業項目または成果物 (コミット、ハイパーリンクなど) へのリンクを作業項目から削除します。 添付ファイルは現在、この関数ではサポートされていません。
reset()	作業中の作業項目の変更をリセットします。 ユーザーに確認を求めるメッセージが表示されます。
save()	作業中の作業項目を保存します。
setError(string)	作業項目を無効としてマークし、フォームに作業項目を保存できないようにします。
setFieldValue(string, Object)	作業中の作業項目のフィールド値を設定します。
setFieldValues({[fieldName: string]: Object})	作業中の作業項目のフィールド値を設定します。

メソッドの詳細

addWorkItemRelations(WorkItemRelation[])

別の作業項目または成果物 (コミット、ハイパーリンクなど) のリンクを作業項目に追加します。 添付ファイルは現在、この関数ではサポートされていません。

function addWorkItemRelations(workItemRelations: WorkItemRelation[]): Promise<void>

パラメーター

workItemRelations

WorkItemRelation[]

追加する作業項目のリンク。

戻り値

Promise<void>

空の約束。

beginSaveWorkItem(() => void, () => void)

@deprecated: 保存を使用してください

function beginSaveWorkItem(successCallback: () => void, errorCallback: () => void): Promise<void>

パラメーター

successCallback

() => void

errorCallback

() => void

戻り値

Promise<void>

clearError()

setError メソッドによって設定されたエラーをクリアし、フォーム内の作業項目の保存のブロックを解除します。

function clearError(): Promise<void>

戻り値

Promise<void>

getAllowedFieldValues(string)

作業中の作業項目のフィールドに使用できる値を取得します。

function getAllowedFieldValues(fieldReferenceName: string): Promise<Object[]>

パラメーター

fieldReferenceName

string

フィールド参照名

戻り値

Promise<Object[]>

許可される値の配列を返す promise。

getDirtyFields(boolean)

ユーザーまたは作業項目ルールによって変更され、ダーティ状態のフィールドを取得します。

function getDirtyFields(includeSystemChanges?: boolean): Promise<WorkItemField[]>

パラメーター

includeSystemChanges

boolean

作業項目ルールによって設定された変更を結果に含める必要があるかどうかを示すブール値。

戻り値

Promise<WorkItemField[]>

作業項目フィールドの配列ダーティ返す promise。

getFields()

アクティブな作業項目フィールドを取得します。

function getFields(): Promise<WorkItemField[]>

戻り値

Promise<WorkItemField[]>

作業項目フィールドの配列を返す promise。

getFieldValue(string, boolean)

警告

この API は非推奨になりました。

Please use options instead of returnOriginalValue

アクティブな作業項目のフィールド値を取得します。

function getFieldValue(fieldReferenceName: string, returnOriginalValue?: boolean): Promise<Object>

パラメーター

fieldReferenceName

string

フィールド参照名

returnOriginalValue

boolean

(省略可能)false の場合、未保存のフィールド値を取得します。 既定値は false です。

戻り値

Promise<Object>

作業項目フィールドの値を返す promise。

getFieldValue(string, WorkItemOptions)

アクティブな作業項目のフィールド値を取得します。

function getFieldValue(fieldReferenceName: string, options?: WorkItemOptions): Promise<Object>

パラメーター

fieldReferenceName

string

フィールド参照名

options

WorkItemOptions

作業項目のオプション

戻り値

Promise<Object>

作業項目フィールドの値を返す promise。

getFieldValues(string[], boolean)

警告

この API は非推奨になりました。

Please use options instead of returnOriginalValue

アクティブな作業項目のフィールド値を取得します。

function getFieldValues(fieldReferenceNames: string[], returnOriginalValue?: boolean): Promise<{[fieldName: string]: Object}>

パラメーター

fieldReferenceNames

string[]

フィールド参照名の配列

returnOriginalValue

boolean

(省略可能)false の場合、未保存のフィールド値を取得します。 既定値は false です。

戻り値

Promise<{[fieldName: string]: Object}>

作業項目フィールド値のディクショナリ (値のペアへの refName) を返す promise。

getFieldValues(string[], WorkItemOptions)

アクティブな作業項目のフィールド値を取得します。

function getFieldValues(fieldReferenceNames: string[], options?: WorkItemOptions): Promise<{[fieldName: string]: Object}>

パラメーター

fieldReferenceNames

string[]

フィールド参照名の配列

options

WorkItemOptions

作業項目のオプション

戻り値

Promise<{[fieldName: string]: Object}>

作業項目フィールド値のディクショナリ (値のペアへの refName) を返す promise。

getId()

アクティブな作業項目の ID を取得します。

function getId(): Promise<number>

戻り値

Promise<number>

アクティブな作業項目 ID を返す promise。

getIdentityFieldValue(string, WorkItemOptions)

アクティブな作業項目の ID フィールド値を取得します。

function getIdentityFieldValue(fieldReferenceName: string, options?: WorkItemOptions): Promise<IdentityRef>

パラメーター

fieldReferenceName

string

フィールド参照名

options

WorkItemOptions

作業項目のオプション

戻り値

Promise<IdentityRef>

作業項目フィールドの値を返す promise。

getInvalidFields()

作業項目ルールに従って無効な状態のフィールドを取得します。 これらのフィールドは、作業項目を保存する前に変更する必要があります。

function getInvalidFields(): Promise<WorkItemField[]>

戻り値

Promise<WorkItemField[]>

無効な作業項目フィールドの配列を返す promise。

getRevision()

アクティブな作業項目の最新のリビジョンを取得します。

function getRevision(): Promise<number>

戻り値

Promise<number>

アクティブな作業項目の最新のリビジョン ID を返す promise。

getWorkItemRelations()

他の作業項目または成果物 (コミット、ハイパーリンクなど) への作業項目リンクの配列を返します。 添付ファイルは現在、この関数ではサポートされていません。

function getWorkItemRelations(): Promise<WorkItemRelation[]>

戻り値

Promise<WorkItemRelation[]>

作業中の作業項目の作業項目関係の配列を返す promise。

getWorkItemRelationTypes()

作業項目のリレーションシップ型の配列を返します。

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

戻り値

Promise<WorkItemRelationType[]>

作業項目のリレーションシップ型の配列を返す promise。

getWorkItemResourceUrl(number)

指定した作業項目リソースの REST API URL を返します。

function getWorkItemResourceUrl(workItemId: number): Promise<string>

パラメーター

workItemId

number

リソース URL が要求される作業項目の ID。

戻り値

Promise<string>

作業項目の要求されたリソース URL を返す promise。

hasActiveWorkItem()

作業中の作業項目が使用可能な場合は true を返します。

function hasActiveWorkItem(): Promise<boolean>

戻り値

Promise<boolean>

ブール値を返す promise は、アクティブな作業項目が使用可能かどうかを示します。

isDirty()

作業中の作業項目がダーティ場合は true を返します。

function isDirty(): Promise<boolean>

戻り値

Promise<boolean>

ブール値を返す promise は、作業中の作業項目がダーティされているかどうかを示します。

isNew()

作業中の作業項目が新しい場合は true を返します。

function isNew(): Promise<boolean>

戻り値

Promise<boolean>

ブール値を返す promise は、作業中の作業項目が新しいかどうかを示します。

isValid()

作業中の作業項目フィールドがすべて有効な場合は true を返します。

function isValid(): Promise<boolean>

戻り値

Promise<boolean>

ブール値を返す promise は、すべてのフィールド値が有効かどうかを示します。

refresh()

アクティブな作業項目を更新します。 作業項目がダーティされている場合は、ユーザーにメッセージが表示されます。

function refresh(): Promise<void>

戻り値

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

別の作業項目または成果物 (コミット、ハイパーリンクなど) へのリンクを作業項目から削除します。 添付ファイルは現在、この関数ではサポートされていません。

function removeWorkItemRelations(workItemRelations: WorkItemRelation[]): Promise<void>

パラメーター

workItemRelations

WorkItemRelation[]

削除する作業項目のリンク。

戻り値

Promise<void>

空の約束。

reset()

作業中の作業項目の変更をリセットします。 ユーザーに確認を求めるメッセージが表示されます。

function reset(): Promise<void>

戻り値

Promise<void>

save()

作業中の作業項目を保存します。

function save(): Promise<void>

戻り値

Promise<void>

作業項目が正常に保存された場合に解決され、失敗した場合は拒否される Promise。

setError(string)

作業項目を無効としてマークし、フォームに作業項目を保存できないようにします。

function setError(errorMessage: string): Promise<void>

パラメーター

errorMessage

string

作業項目フォームの上に表示されるカスタム エラー メッセージ。

戻り値

Promise<void>

setFieldValue(string, Object)

作業中の作業項目のフィールド値を設定します。

function setFieldValue(fieldReferenceName: string, value: Object): Promise<boolean>

パラメーター

fieldReferenceName

string

フィールド参照名

value

Object

フィールド値

戻り値

Promise<boolean>

ブール値を返す promise は、関数が正常に完了したかどうかを示します。

setFieldValues({[fieldName: string]: Object})

作業中の作業項目のフィールド値を設定します。

function setFieldValues(fields: {[fieldName: string]: Object}): Promise<{[fieldName: string]: boolean}>

パラメーター

fields

{[fieldName: string]: Object}

フィールド refName/values のディクショナリ

戻り値

Promise<{[fieldName: string]: boolean}>

フィールド値更新結果のディクショナリ (refName と結果のペア) を返す promise。