IWorkItemFormService interface

Пакет:

azure-devops-extension-api

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

Методы

addWorkItemRelations(WorkItemRelation[])	Добавляет в рабочий элемент ссылки на другие рабочие элементы или артефакты (например, коммиты, гиперссылки). Вложение в настоящее время не поддерживается этой функцией.
beginSaveWorkItem(() => void, () => void)	@deprecated: Пожалуйста, используйте save
clearError()	Очищает ошибку, заданную методом setError, и разблокирует сохранение рабочего элемента в форме.
getAllowedFieldValues(string)	Получает допустимые значения для поля активного рабочего элемента.
getDirtyFields(boolean)	Получает поля, которые были изменены пользователем или правилом рабочего элемента и находятся в измененном состоянии.
getFields()	Получает активные поля рабочих элементов.
getFieldValue(string, boolean)	Получает значение поля активного рабочего элемента.
getFieldValue(string, WorkItemOptions)	Получает значение поля активного рабочего элемента.
getFieldValues(string[], boolean)	Получает значения полей активного рабочего элемента.
getFieldValues(string[], WorkItemOptions)	Получает значения полей активного рабочего элемента.
getId()	Получает идентификатор активного рабочего элемента.
getIdentityFieldValue(string, WorkItemOptions)	Получает значение поля identity активного рабочего элемента.
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: Пожалуйста, используйте save

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)

Получает значение поля identity активного рабочего элемента.

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 к парам результатов).