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)	获取活动工作项的标识字段值。
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[]>

返回脏工作项字段数组的承诺。

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()

获取活动工作项的 ID。

function getId(): Promise<number>

返回

Promise<number>

返回活动工作项 ID 的承诺。

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>

一个承诺，返回活动工作项的最新修订 ID。

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 的工作项的 ID。

返回

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}

字段 refName/values 的字典

返回

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

返回字段值字典的承诺将结果更新 (refName 更新为结果对) 。