IWorkItemFormService interface

Balíček:

azure-devops-extension-api

Hostitelská služba pro interakci s aktuálně aktivním formulářem pracovní položky (pracovní položka aktuálně zobrazená v uživatelském rozhraní). Služba formuláře závisí na aktuálním kontextu aktivní pracovní položky. Vyvolá chybu, pokud není otevřená pracovní položka.

Metody

addWorkItemRelations(WorkItemRelation[])	Přidá k pracovní položce odkazy na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.
beginSaveWorkItem(() => void, () => void)	@deprecated: Použijte možnost Uložit.
clearError()	Vymaže chybu nastavenou metodou setError a odblokuje uložení pracovní položky ve formuláři.
getAllowedFieldValues(string)	Získá povolené hodnoty pole aktivní pracovní položky.
getDirtyFields(boolean)	Získá pole, která byla změněna uživatelem nebo pravidlem pracovní položky a jsou ve špinavém stavu.
getFields()	Získá aktivní pole pracovní položky.
getFieldValue(string, boolean)	Získá hodnotu pole aktivní pracovní položky.
getFieldValue(string, WorkItemOptions)	Získá hodnotu pole aktivní pracovní položky.
getFieldValues(string[], boolean)	Získá hodnoty pole aktivní pracovní položky.
getFieldValues(string[], WorkItemOptions)	Získá hodnoty pole aktivní pracovní položky.
getId()	Získá ID aktivní pracovní položky.
getIdentityFieldValue(string, WorkItemOptions)	Získá hodnotu pole identity aktivní pracovní položky.
getInvalidFields()	Získá pole, která jsou v neplatném stavu podle pravidel pracovní položky. Před uložením pracovní položky je potřeba tato pole změnit.
getRevision()	Získá nejnovější revizi aktivní pracovní položky.
getWorkItemRelations()	Vrátí pole odkazů pracovních položek na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.
getWorkItemRelationTypes()	Vrátí pole typů relací pracovních položek.
getWorkItemResourceUrl(number)	Vrátí adresu URL rozhraní REST API zadaného prostředku pracovní položky.
hasActiveWorkItem()	Vrátí hodnotu true, pokud je k dispozici aktivní pracovní položka.
isDirty()	Vrátí hodnotu true, pokud je aktivní pracovní položka zašpiněná.
isNew()	Vrátí hodnotu true, pokud je aktivní pracovní položka nová.
isValid()	Vrátí hodnotu true, pokud jsou všechna aktivní pole pracovní položky platná.
refresh()	Aktualizuje aktivní pracovní položku. Zobrazí uživateli výzvu, pokud je pracovní položka zašpiněná.
removeWorkItemRelations(WorkItemRelation[])	Odebere z pracovní položky odkazy na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.
reset()	Resetujte všechny změny v aktivní pracovní položce. Vyzve uživatele k potvrzení.
save()	Uloží aktivní pracovní položku.
setError(string)	Označí pracovní položku jako neplatnou a zakáže ukládání pracovní položky do formuláře.
setFieldValue(string, Object)	Nastaví hodnotu pole aktivní pracovní položky.
setFieldValues({[fieldName: string]: Object})	Nastaví hodnoty polí aktivní pracovní položky.

Podrobnosti metody

addWorkItemRelations(WorkItemRelation[])

Přidá k pracovní položce odkazy na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.

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

Parametry

workItemRelations

WorkItemRelation[]

Odkazy na pracovní položky, které chcete přidat.

Návraty

Promise<void>

Prázdný slib.

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

@deprecated: Použijte možnost Uložit.

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

Parametry

successCallback

() => void

errorCallback

() => void

Návraty

Promise<void>

clearError()

Vymaže chybu nastavenou metodou setError a odblokuje uložení pracovní položky ve formuláři.

function clearError(): Promise<void>

Návraty

Promise<void>

getAllowedFieldValues(string)

Získá povolené hodnoty pole aktivní pracovní položky.

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

Parametry

fieldReferenceName

string

Název odkazu na pole

Návraty

Promise<Object[]>

Příslib, který vrátí pole povolených hodnot.

getDirtyFields(boolean)

Získá pole, která byla změněna uživatelem nebo pravidlem pracovní položky a jsou ve špinavém stavu.

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

Parametry

includeSystemChanges

boolean

Logická hodnota označující, jestli má výsledek obsahovat změny nastavené pravidly pracovních položek.

Návraty

Promise<WorkItemField[]>

Příslib, který vrátí pole polí se špinavými pracovními položkami.

getFields()

Získá aktivní pole pracovní položky.

function getFields(): Promise<WorkItemField[]>

Návraty

Promise<WorkItemField[]>

Příslib, který vrátí pole pracovní položky.

getFieldValue(string, boolean)

Upozornění

Toto rozhraní API je teď zastaralé.

Please use options instead of returnOriginalValue

Získá hodnotu pole aktivní pracovní položky.

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

Parametry

fieldReferenceName

string

Název odkazu na pole

returnOriginalValue

boolean

(Volitelné) Pokud je false, získá neuložené hodnoty pole. Výchozí hodnota je false.

Návraty

Promise<Object>

Příslib, který vrátí hodnotu pole pracovní položky.

getFieldValue(string, WorkItemOptions)

Získá hodnotu pole aktivní pracovní položky.

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

Parametry

fieldReferenceName

string

Název odkazu na pole

options

WorkItemOptions

Možnosti pracovní položky

Návraty

Promise<Object>

Příslib, který vrátí hodnotu pole pracovní položky.

getFieldValues(string[], boolean)

Upozornění

Toto rozhraní API je teď zastaralé.

Please use options instead of returnOriginalValue

Získá hodnoty pole aktivní pracovní položky.

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

Parametry

fieldReferenceNames

string[]

Předčítání názvů odkazů na pole

returnOriginalValue

boolean

(Volitelné) Pokud je false, získá neuložené hodnoty pole. Výchozí hodnota je false.

Návraty

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

Příslib, který vrátí slovník hodnot polí pracovní položky (odkaz na páry hodnot).

getFieldValues(string[], WorkItemOptions)

Získá hodnoty pole aktivní pracovní položky.

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

Parametry

fieldReferenceNames

string[]

Předčítání názvů odkazů na pole

options

WorkItemOptions

Možnosti pracovní položky

Návraty

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

Příslib, který vrátí slovník hodnot polí pracovní položky (odkaz na páry hodnot).

getId()

Získá ID aktivní pracovní položky.

function getId(): Promise<number>

Návraty

Promise<number>

Příslib, který vrátí ID aktivní pracovní položky.

getIdentityFieldValue(string, WorkItemOptions)

Získá hodnotu pole identity aktivní pracovní položky.

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

Parametry

fieldReferenceName

string

Název odkazu na pole

options

WorkItemOptions

Možnosti pracovní položky

Návraty

Promise<IdentityRef>

Příslib, který vrátí hodnotu pole pracovní položky.

getInvalidFields()

Získá pole, která jsou v neplatném stavu podle pravidel pracovní položky. Před uložením pracovní položky je potřeba tato pole změnit.

function getInvalidFields(): Promise<WorkItemField[]>

Návraty

Promise<WorkItemField[]>

Příslib, který vrací pole neplatných polí pracovní položky.

getRevision()

Získá nejnovější revizi aktivní pracovní položky.

function getRevision(): Promise<number>

Návraty

Promise<number>

Příslib, který vrátí ID nejnovější revize aktivní pracovní položky.

getWorkItemRelations()

Vrátí pole odkazů pracovních položek na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Návraty

Promise<WorkItemRelation[]>

Příslib, který vrací pole vztahů pracovních položek aktivní pracovní položky.

getWorkItemRelationTypes()

Vrátí pole typů relací pracovních položek.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Návraty

Promise<WorkItemRelationType[]>

Příslib, který vrací pole typů relací pracovních položek.

getWorkItemResourceUrl(number)

Vrátí adresu URL rozhraní REST API zadaného prostředku pracovní položky.

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

Parametry

workItemId

number

ID pracovní položky, pro kterou je adresa URL zdroje požadována.

Návraty

Promise<string>

Příslib, který vrátí požadovanou adresu URL zdroje pracovní položky.

hasActiveWorkItem()

Vrátí hodnotu true, pokud je k dispozici aktivní pracovní položka.

function hasActiveWorkItem(): Promise<boolean>

Návraty

Promise<boolean>

Příslib, který vrací logickou hodnotu, označuje, jestli je aktivní pracovní položka k dispozici.

isDirty()

Vrátí hodnotu true, pokud je aktivní pracovní položka zašpiněná.

function isDirty(): Promise<boolean>

Návraty

Promise<boolean>

Příslib, který vrací logickou hodnotu, označuje, jestli je aktivní pracovní položka nečistá.

isNew()

Vrátí hodnotu true, pokud je aktivní pracovní položka nová.

function isNew(): Promise<boolean>

Návraty

Promise<boolean>

Příslib, který vrací logickou hodnotu, označuje, jestli je aktivní pracovní položka nová.

isValid()

Vrátí hodnotu true, pokud jsou všechna aktivní pole pracovní položky platná.

function isValid(): Promise<boolean>

Návraty

Promise<boolean>

Příslib, který vrací logickou hodnotu, označuje, jestli jsou všechny hodnoty polí platné.

refresh()

Aktualizuje aktivní pracovní položku. Zobrazí uživateli výzvu, pokud je pracovní položka zašpiněná.

function refresh(): Promise<void>

Návraty

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Odebere z pracovní položky odkazy na jiné pracovní položky nebo artefakty (např. potvrzení, hypertextové odkazy). Tato funkce aktuálně nepodporuje přílohu.

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

Parametry

workItemRelations

WorkItemRelation[]

Odkazy na pracovní položky, které chcete odebrat.

Návraty

Promise<void>

Prázdný slib.

reset()

Resetujte všechny změny v aktivní pracovní položce. Vyzve uživatele k potvrzení.

function reset(): Promise<void>

Návraty

Promise<void>

save()

Uloží aktivní pracovní položku.

function save(): Promise<void>

Návraty

Promise<void>

Příslib, který je vyřešen, pokud je pracovní položka úspěšně uložena a odmítnuta, pokud selže.

setError(string)

Označí pracovní položku jako neplatnou a zakáže ukládání pracovní položky do formuláře.

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

Parametry

errorMessage

string

Vlastní chybová zpráva, která by se zobrazila nad formulářem pracovní položky.

Návraty

Promise<void>

setFieldValue(string, Object)

Nastaví hodnotu pole aktivní pracovní položky.

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

Parametry

fieldReferenceName

string

Název odkazu na pole

value

Object

Hodnota pole

Návraty

Promise<boolean>

Příslib, který vrací logickou hodnotu, označuje, jestli se funkce úspěšně dokončila.

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

Nastaví hodnoty polí aktivní pracovní položky.

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

Parametry

fields

{[fieldName: string]: Object}

Slovník pole refName/values

Návraty

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

Příslib, který vrací slovník výsledků aktualizace hodnoty pole (odkaz na dvojice výsledků).