IWorkItemFormService interface

将另一个工作项或项目的链接 （例如提交、超链接） 添加到工作项。 此功能目前不支持附件。

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

参数

返回

一个空洞的承诺。

@deprecated：请使用保存

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

参数

返回

清除 setError 方法设置的错误，并取消阻止在窗体中保存工作项。

function clearError(): Promise<void>

返回

获取活动工作项上字段的允许值。

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

参数

返回

返回允许值数组的 Promise。

获取已由用户或工作项规则更改且处于脏状态的字段。

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

参数

返回

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

获取活动工作项字段。

function getFields(): Promise<WorkItemField[]>

返回

返回工作项字段数组的 Promise。

获取活动工作项的字段值。

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

参数

返回

返回工作项字段值的 Promise。

获取活动工作项的字段值。

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

参数

返回

返回工作项字段值的 Promise。

获取活动工作项的字段值。

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

参数

返回

返回工作项字段值字典的 Promise （refName 到值对） 。

获取活动工作项的字段值。

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

参数

返回

返回工作项字段值字典的 Promise （refName 到值对） 。

获取活动工作项的 ID。

function getId(): Promise<number>

返回

返回活动工作项 ID 的 Promise。

获取活动工作项的标识字段值。

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

参数

返回

返回工作项字段值的 Promise。

根据工作项规则获取处于无效状态的字段。 需要先更改这些字段，然后才能保存工作项。

function getInvalidFields(): Promise<WorkItemField[]>

返回

返回无效工作项字段数组的 Promise。

获取活动工作项的最新修订。

function getRevision(): Promise<number>

返回

返回活动工作项的最新修订 ID 的 Promise。

返回指向其他工作项或项目的工作项链接数组 （，例如提交、超链接） 。 此功能目前不支持附件。

function getWorkItemRelations(): Promise<WorkItemRelation[]>

返回

返回活动工作项的工作项关系数组的 Promise。

返回工作项关系类型的数组。

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

返回

返回工作项关系类型数组的 Promise。

返回指定工作项资源的 REST API URL。

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

参数

返回

返回工作项的请求资源 URL 的 Promise。

如果活动工作项可用，则返回 true。

function hasActiveWorkItem(): Promise<boolean>

返回

返回布尔值的 Promise 指示活动工作项是否可用。

如果活动工作项是脏的，则返回 true。

function isDirty(): Promise<boolean>

返回

返回布尔值的 Promise 指示活动工作项是否脏。

如果活动工作项是新的，则返回 true。

function isNew(): Promise<boolean>

返回

返回布尔值的 Promise 指示活动工作项是否为新工作项。

如果活动工作项字段全部有效，则返回 true。

function isValid(): Promise<boolean>

返回

返回布尔值的 Promise 指示是否所有字段值都有效。

刷新活动工作项。 将提示用户工作项是否脏。

function refresh(): Promise<void>

返回

从工作项中删除指向另一个工作项或项目的链接 （例如提交、超链接） 。 此功能目前不支持附件。

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

参数

返回

一个空洞的承诺。

重置活动工作项中的任何更改。 将提示用户确认。

function reset(): Promise<void>

返回

保存活动工作项。

function save(): Promise<void>

返回

如果工作项保存成功，则解析并拒绝失败的 Promise。

将工作项标记为无效，并禁用在窗体上保存工作项。

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

参数

返回

设置活动工作项的字段值。

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

参数

返回

返回布尔值的 Promise 指示函数是否成功完成。

设置活动工作项的字段值。

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

参数

返回

返回字段值更新结果字典的 Promise（结果对的 refName）。