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()	取得使用中工作項目的標識碼。
getIdentityFieldValue(string, WorkItemOptions)	取得使用中工作項目的識別域值。
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[]>

會傳回允許值陣列的承諾。

getDirtyFields(boolean)

取得使用者或工作項目規則已變更且處於骯髒狀態的字段。

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

參數

includeSystemChanges

boolean

布爾值，指出結果是否應該包含工作項目規則所設定的變更。

傳回

Promise<WorkItemField[]>

會傳回骯髒工作專案欄位陣列的承諾。

getFields()

取得使用中的工作專案欄位。

function getFields(): Promise<WorkItemField[]>

傳回

Promise<WorkItemField[]>

會傳回工作專案欄位陣列的承諾。

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>

會傳回工作專案欄位值的承諾。

getFieldValue(string, WorkItemOptions)

取得使用中工作專案的域值。

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

參數

fieldReferenceName

string

欄位參考名稱

options

WorkItemOptions

工作項目選項

傳回

Promise<Object>

會傳回工作專案欄位值的承諾。

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 至值組） 的承諾。

getFieldValues(string[], WorkItemOptions)

取得使用中工作專案的域值。

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

參數

fieldReferenceNames

string[]

欄位參考名稱的欠款

options

WorkItemOptions

工作項目選項

傳回

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

會傳回工作專案域值的字典 （refName 至值組） 的承諾。

getId()

取得使用中工作項目的標識碼。

function getId(): Promise<number>

傳回

Promise<number>

會傳回使用中工作專案標識碼的承諾。

getIdentityFieldValue(string, WorkItemOptions)

取得使用中工作項目的識別域值。

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

參數

fieldReferenceName

string

欄位參考名稱

options

WorkItemOptions

工作項目選項

傳回

Promise<IdentityRef>

會傳回工作專案欄位值的承諾。

getInvalidFields()

根據工作項目規則取得處於無效狀態的欄位。 必須先變更這些欄位，才能儲存工作專案。

function getInvalidFields(): Promise<WorkItemField[]>

傳回

Promise<WorkItemField[]>

會傳回無效工作專案欄位數位的承諾。

getRevision()

取得使用中工作專案的最新修訂。

function getRevision(): Promise<number>

傳回

Promise<number>

會傳回使用中工作專案最新修訂標識符的承諾。

getWorkItemRelations()

傳回工作項目連結至其他工作專案或成品的陣列（例如認可、超連結）。 此函式目前不支援附件。

function getWorkItemRelations(): Promise<WorkItemRelation[]>

傳回

Promise<WorkItemRelation[]>

會傳回使用中工作專案之工作專案關聯數位的承諾。

getWorkItemRelationTypes()

傳回工作項目關聯型別的陣列。

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

傳回

Promise<WorkItemRelationType[]>

會傳回工作項目關聯型別數位的承諾。

getWorkItemResourceUrl(number)

傳回指定工作項目資源的 REST API URL。

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

參數

workItemId

number

要求資源 URL 的工作項目識別碼。

傳回

Promise<string>

會傳回工作專案所要求資源 URL 的承諾。

hasActiveWorkItem()

如果可用的使用中工作專案，則傳回 true。

function hasActiveWorkItem(): Promise<boolean>

傳回

Promise<boolean>

傳回布爾值的承諾會指出作用中工作專案是否可用。

isDirty()

如果作用中的工作專案已變更，則傳回 true。

function isDirty(): Promise<boolean>

傳回

Promise<boolean>

傳回布爾值的承諾會指出作用中工作專案是否已變更。

isNew()

如果使用中的工作專案是新的，則傳回 true。

function isNew(): Promise<boolean>

傳回

Promise<boolean>

傳回布爾值的承諾會指出使用中工作專案是否為新專案。

isValid()

如果作用中的工作專案欄位全部有效，則傳回 true。

function isValid(): Promise<boolean>

傳回

Promise<boolean>

傳回布爾值的承諾表示所有域值是否有效。

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>

如果成功儲存工作專案，且在失敗時遭到拒絕，則為已解決的承諾。

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>

傳回布爾值的承諾表示函式是否順利完成。

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

設定使用中工作專案的域值。

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

參數

fields

{[fieldName: string]: Object}

field refName/values 的字典

傳回

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

會傳回域值更新結果字典的承諾 （refName 至結果組）。