IWorkItemFormService interface

Pakiet:

azure-devops-extension-api

Usługa hosta do interakcji z aktualnie aktywnym formularzem elementu roboczego (element roboczy aktualnie wyświetlany w interfejsie użytkownika). Usługa formularzy zależy od bieżącego aktywnego kontekstu elementu roboczego. Spowoduje zgłoszenie błędu, gdy nie ma otwartego elementu roboczego.

Metody

addWorkItemRelations(WorkItemRelation[])	Dodaje łącza do innego elementu roboczego lub artefaktów (np. zatwierdzeń, hiperlinków) do elementu roboczego. Załącznik nie jest obecnie obsługiwany przez tę funkcję.
beginSaveWorkItem(() => void, () => void)	@deprecated: Użyj polecenia zapisz
clearError()	Czyści błąd ustawiony przez metodę setError i odblokuje zapisywanie elementu roboczego w formularzu.
getAllowedFieldValues(string)	Pobiera dozwolone wartości pola w aktywnym elemencie roboczym.
getDirtyFields(boolean)	Pobiera pola, które zostały zmienione przez użytkownika lub przez regułę elementu roboczego i są w stanie brudnym.
getFields()	Pobiera aktywne pola elementów roboczych.
getFieldValue(string, boolean)	Pobiera wartość pola aktywnego elementu roboczego.
getFieldValue(string, WorkItemOptions)	Pobiera wartość pola aktywnego elementu roboczego.
getFieldValues(string[], boolean)	Pobiera wartości pól aktywnego elementu roboczego.
getFieldValues(string[], WorkItemOptions)	Pobiera wartości pól aktywnego elementu roboczego.
getId()	Pobiera identyfikator aktywnego elementu roboczego.
getIdentityFieldValue(string, WorkItemOptions)	Pobiera wartość pola tożsamości aktywnego elementu roboczego.
getInvalidFields()	Pobiera pola, które są w nieprawidłowym stanie zgodnie z regułami elementów roboczych. Te pola należy zmienić przed zapisaniem elementu roboczego.
getRevision()	Pobiera najnowszą wersję aktywnego elementu roboczego.
getWorkItemRelations()	Zwraca tablicę łączy elementów roboczych z innymi elementami roboczymi lub artefaktami (np. zatwierdzeniami, hiperlinkami). Załącznik nie jest obecnie obsługiwany przez tę funkcję.
getWorkItemRelationTypes()	Zwraca tablicę typów relacyjnych elementów roboczych.
getWorkItemResourceUrl(number)	Zwraca adres URL interfejsu API REST określonego zasobu elementu roboczego.
hasActiveWorkItem()	Zwraca wartość true, jeśli aktywny element roboczy jest dostępny.
isDirty()	Zwraca wartość true, jeśli aktywny element roboczy jest zanieczyszczony.
isNew()	Zwraca wartość true, jeśli aktywny element roboczy jest nowy.
isValid()	Zwraca wartość true, jeśli wszystkie aktywne pola elementu roboczego są prawidłowe.
refresh()	Odświeża aktywny element roboczy. Monituje użytkownika, jeśli element roboczy jest zanieczyszczony.
removeWorkItemRelations(WorkItemRelation[])	Usuwa łącza do innych elementów roboczych lub artefaktów (np. zatwierdzeń, hiperlinków) z elementu roboczego. Załącznik nie jest obecnie obsługiwany przez tę funkcję.
reset()	Zresetuj wszelkie zmiany w aktywnym elemencie roboczym. Monituje użytkownika o potwierdzenie.
save()	Zapisuje aktywny element roboczy.
setError(string)	Oznacza element roboczy jako nieprawidłowy i wyłącza zapisywanie elementu roboczego w formularzu.
setFieldValue(string, Object)	Ustawia wartość pola aktywnego elementu roboczego.
setFieldValues({[fieldName: string]: Object})	Ustawia wartości pól aktywnego elementu roboczego.

Szczegóły metody

addWorkItemRelations(WorkItemRelation[])

Dodaje łącza do innego elementu roboczego lub artefaktów (np. zatwierdzeń, hiperlinków) do elementu roboczego. Załącznik nie jest obecnie obsługiwany przez tę funkcję.

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

Parametry

workItemRelations

WorkItemRelation[]

Linki elementu roboczego do dodania.

Zwraca

Promise<void>

Pusta obietnica.

beginSaveWorkItem(() => void, () => void)

@deprecated: Użyj polecenia zapisz

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

Parametry

successCallback

() => void

errorCallback

() => void

Zwraca

Promise<void>

clearError()

Czyści błąd ustawiony przez metodę setError i odblokuje zapisywanie elementu roboczego w formularzu.

function clearError(): Promise<void>

Zwraca

Promise<void>

getAllowedFieldValues(string)

Pobiera dozwolone wartości pola w aktywnym elemencie roboczym.

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

Parametry

fieldReferenceName

string

Nazwa odwołania do pola

Zwraca

Promise<Object[]>

Obietnica zwracająca tablicę dozwolonych wartości.

getDirtyFields(boolean)

Pobiera pola, które zostały zmienione przez użytkownika lub przez regułę elementu roboczego i są w stanie brudnym.

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

Parametry

includeSystemChanges

boolean

Wartość logiczna wskazująca, czy wynik powinien zawierać zmiany ustawione przez reguły elementów roboczych.

Zwraca

Promise<WorkItemField[]>

Obietnica zwracająca tablicę brudnych pól elementów roboczych.

getFields()

Pobiera aktywne pola elementów roboczych.

function getFields(): Promise<WorkItemField[]>

Zwraca

Promise<WorkItemField[]>

Obietnica zwracająca tablicę pola elementu roboczego.

getFieldValue(string, boolean)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Please use options instead of returnOriginalValue

Pobiera wartość pola aktywnego elementu roboczego.

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

Parametry

fieldReferenceName

string

Nazwa odwołania do pola

returnOriginalValue

boolean

(Opcjonalnie) Jeśli wartość false, pobiera niezapisane wartości pól. Wartość domyślna to false.

Zwraca

Promise<Object>

Obietnica zwracająca wartość pola elementu roboczego.

getFieldValue(string, WorkItemOptions)

Pobiera wartość pola aktywnego elementu roboczego.

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

Parametry

fieldReferenceName

string

Nazwa odwołania do pola

options

WorkItemOptions

opcje elementów roboczych

Zwraca

Promise<Object>

Obietnica zwracająca wartość pola elementu roboczego.

getFieldValues(string[], boolean)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Please use options instead of returnOriginalValue

Pobiera wartości pól aktywnego elementu roboczego.

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

Parametry

fieldReferenceNames

string[]

Arrary nazw odwołań do pól

returnOriginalValue

boolean

(Opcjonalnie) Jeśli wartość false, pobiera niezapisane wartości pól. Wartość domyślna to false.

Zwraca

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

Obietnica zwracająca słownik wartości pól elementu roboczego (refName do par wartości).

getFieldValues(string[], WorkItemOptions)

Pobiera wartości pól aktywnego elementu roboczego.

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

Parametry

fieldReferenceNames

string[]

Arrary nazw odwołań do pól

options

WorkItemOptions

opcje elementów roboczych

Zwraca

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

Obietnica zwracająca słownik wartości pól elementu roboczego (refName do par wartości).

getId()

Pobiera identyfikator aktywnego elementu roboczego.

function getId(): Promise<number>

Zwraca

Promise<number>

Obietnica zwracająca aktywny identyfikator elementu roboczego.

getIdentityFieldValue(string, WorkItemOptions)

Pobiera wartość pola tożsamości aktywnego elementu roboczego.

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

Parametry

fieldReferenceName

string

Nazwa odwołania do pola

options

WorkItemOptions

opcje elementów roboczych

Zwraca

Promise<IdentityRef>

Obietnica zwracająca wartość pola elementu roboczego.

getInvalidFields()

Pobiera pola, które są w nieprawidłowym stanie zgodnie z regułami elementów roboczych. Te pola należy zmienić przed zapisaniem elementu roboczego.

function getInvalidFields(): Promise<WorkItemField[]>

Zwraca

Promise<WorkItemField[]>

Obietnica zwracająca tablicę nieprawidłowych pól elementu roboczego.

getRevision()

Pobiera najnowszą wersję aktywnego elementu roboczego.

function getRevision(): Promise<number>

Zwraca

Promise<number>

Obietnica zwracająca najnowszy identyfikator poprawki aktywnego elementu roboczego.

getWorkItemRelations()

Zwraca tablicę łączy elementów roboczych z innymi elementami roboczymi lub artefaktami (np. zatwierdzeniami, hiperlinkami). Załącznik nie jest obecnie obsługiwany przez tę funkcję.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Zwraca

Promise<WorkItemRelation[]>

Obietnica zwracająca tablicę relacji elementów roboczych aktywnego elementu roboczego.

getWorkItemRelationTypes()

Zwraca tablicę typów relacyjnych elementów roboczych.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Zwraca

Promise<WorkItemRelationType[]>

Obietnica zwracająca tablicę typów relacyjnych elementów roboczych.

getWorkItemResourceUrl(number)

Zwraca adres URL interfejsu API REST określonego zasobu elementu roboczego.

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

Parametry

workItemId

number

Identyfikator elementu roboczego, dla którego jest wymagany adres URL zasobu.

Zwraca

Promise<string>

Obietnica zwracająca żądany adres URL zasobu elementu roboczego.

hasActiveWorkItem()

Zwraca wartość true, jeśli aktywny element roboczy jest dostępny.

function hasActiveWorkItem(): Promise<boolean>

Zwraca

Promise<boolean>

Obietnica zwracająca wartość logiczną wskazuje, czy aktywny element roboczy jest dostępny.

isDirty()

Zwraca wartość true, jeśli aktywny element roboczy jest zanieczyszczony.

function isDirty(): Promise<boolean>

Zwraca

Promise<boolean>

Obietnica zwracająca wartość logiczną wskazuje, czy aktywny element roboczy jest zanieczyszczony.

isNew()

Zwraca wartość true, jeśli aktywny element roboczy jest nowy.

function isNew(): Promise<boolean>

Zwraca

Promise<boolean>

Obietnica zwracająca wartość logiczną wskazuje, czy aktywny element roboczy jest nowy.

isValid()

Zwraca wartość true, jeśli wszystkie aktywne pola elementu roboczego są prawidłowe.

function isValid(): Promise<boolean>

Zwraca

Promise<boolean>

Obietnica zwracająca wartość logiczną wskazuje, czy wszystkie wartości pól są prawidłowe.

refresh()

Odświeża aktywny element roboczy. Monituje użytkownika, jeśli element roboczy jest zanieczyszczony.

function refresh(): Promise<void>

Zwraca

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Usuwa łącza do innych elementów roboczych lub artefaktów (np. zatwierdzeń, hiperlinków) z elementu roboczego. Załącznik nie jest obecnie obsługiwany przez tę funkcję.

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

Parametry

workItemRelations

WorkItemRelation[]

Łącza elementów roboczych do usunięcia.

Zwraca

Promise<void>

Pusta obietnica.

reset()

Zresetuj wszelkie zmiany w aktywnym elemencie roboczym. Monituje użytkownika o potwierdzenie.

function reset(): Promise<void>

Zwraca

Promise<void>

save()

Zapisuje aktywny element roboczy.

function save(): Promise<void>

Zwraca

Promise<void>

Obietnica, która zostanie rozwiązana, jeśli element roboczy zostanie zapisany pomyślnie i odrzucony, jeśli zakończy się niepowodzeniem.

setError(string)

Oznacza element roboczy jako nieprawidłowy i wyłącza zapisywanie elementu roboczego w formularzu.

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

Parametry

errorMessage

string

Niestandardowy komunikat o błędzie, który będzie wyświetlany w górnej części formularza elementu roboczego.

Zwraca

Promise<void>

setFieldValue(string, Object)

Ustawia wartość pola aktywnego elementu roboczego.

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

Parametry

fieldReferenceName

string

Nazwa odwołania do pola

value

Object

Wartość pola

Zwraca

Promise<boolean>

Obietnica zwracająca wartość logiczną wskazuje, czy funkcja została ukończona pomyślnie.

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

Ustawia wartości pól aktywnego elementu roboczego.

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

Parametry

fields

{[fieldName: string]: Object}

Słownik pól refName/values

Zwraca

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

Obietnica zwracająca słownik wyników aktualizacji wartości pola (refName do par wyników).