IWorkItemFormService interface

Пакет:

azure-devops-extension-api

Служба узла для взаимодействия с текущей активной формой рабочего элемента (рабочий элемент, который в настоящее время отображается в пользовательском интерфейсе). Служба форм зависит от текущего активного контекста рабочего элемента. Выдает ошибку при отсутствии открытого рабочего элемента.

Методы

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)	Возвращает URL-адрес REST API указанного ресурса рабочего элемента.
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)

Возвращает URL-адрес REST API указанного ресурса рабочего элемента.

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}

Словарь полей refName/values

Возвращаемое значение

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

Обещание, возвращающее словарь результатов обновления значений поля (refName на пары результатов).