IWorkItemFormService interface

Pakket:

azure-devops-extension-api

Hostservice voor interactie met het formulier voor actieve werkitems (werkitem wordt momenteel weergegeven in de gebruikersinterface). De formulierservice is afhankelijk van de huidige context van het actieve werkitem. Er wordt een fout gegenereerd wanneer er geen geopend werkitem is.

Methoden

addWorkItemRelations(WorkItemRelation[])	Hiermee voegt u koppelingen van andere werkitems of artefacten (bijvoorbeeld doorvoeringen, hyperlinks) toe aan het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.
beginSaveWorkItem(() => void, () => void)	@deprecated: gebruik opslaan
clearError()	Wist de fout die is ingesteld met de methode setError en deblokkert het opslaan van het werkitem in het formulier op.
getAllowedFieldValues(string)	Hiermee haalt u de toegestane waarden op voor het veld voor het actieve werkitem.
getDirtyFields(boolean)	Hiermee haalt u velden op die zijn gewijzigd door de gebruiker of door een werkitemregel en die een vervuilde status hebben.
getFields()	Hiermee haalt u actieve werkitemvelden op.
getFieldValue(string, boolean)	Hiermee wordt de veldwaarde van het actieve werkitem opgehaald.
getFieldValue(string, WorkItemOptions)	Hiermee wordt de veldwaarde van het actieve werkitem opgehaald.
getFieldValues(string[], boolean)	Hiermee worden veldwaarden van het actieve werkitem opgehaald.
getFieldValues(string[], WorkItemOptions)	Hiermee worden veldwaarden van het actieve werkitem opgehaald.
getId()	Hiermee wordt de id van het actieve werkitem opgehaald.
getIdentityFieldValue(string, WorkItemOptions)	Hiermee wordt de waarde van het identiteitsveld van het actieve werkitem opgehaald.
getInvalidFields()	Hiermee haalt u velden op die een ongeldige status hebben volgens de regels voor werkitems. Deze velden moeten worden gewijzigd voordat het werkitem kan worden opgeslagen.
getRevision()	Hiermee haalt u de meest recente revisie van het actieve werkitem op.
getWorkItemRelations()	Retourneert een matrix met werkitemkoppelingen naar andere werkitems of artefacten (bijvoorbeeld doorvoeringen, hyperlinks). Bijlage wordt momenteel niet ondersteund door deze functie.
getWorkItemRelationTypes()	Retourneert een matrix met relatietypen voor werkitems.
getWorkItemResourceUrl(number)	Retourneert de REST API-URL van de opgegeven werkitemresource.
hasActiveWorkItem()	Retourneert true als het actieve werkitem beschikbaar is.
isDirty()	Retourneert true als het actieve werkitem vuil is.
isNew()	Retourneert true als het actieve werkitem nieuw is.
isValid()	Retourneert true als de actieve werkitemvelden allemaal geldig zijn.
refresh()	Hiermee vernieuwt u het actieve werkitem. De gebruiker wordt gevraagd of het werkitem vuil is.
removeWorkItemRelations(WorkItemRelation[])	Hiermee verwijdert u koppelingen naar andere werkitems of artefacten (zoals doorvoeringen, hyperlinks) uit het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.
reset()	Stel eventuele wijzigingen in het actieve werkitem opnieuw in. De gebruiker wordt gevraagd dit te bevestigen.
save()	Hiermee slaat u het actieve werkitem op.
setError(string)	Markeert het werkitem als ongeldig en schakel het opslaan van het werkitem in het formulier uit.
setFieldValue(string, Object)	Hiermee stelt u de veldwaarde van het actieve werkitem in.
setFieldValues({[fieldName: string]: Object})	Hiermee stelt u veldwaarden van het actieve werkitem in.

Methodedetails

addWorkItemRelations(WorkItemRelation[])

Hiermee voegt u koppelingen van andere werkitems of artefacten (bijvoorbeeld doorvoeringen, hyperlinks) toe aan het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.

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

Parameters

workItemRelations

WorkItemRelation[]

Werkitemkoppelingen om toe te voegen.

Retouren

Promise<void>

Een loze belofte.

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

@deprecated: gebruik opslaan

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

Parameters

successCallback

() => void

errorCallback

() => void

Retouren

Promise<void>

clearError()

Wist de fout die is ingesteld met de methode setError en deblokkert het opslaan van het werkitem in het formulier op.

function clearError(): Promise<void>

Retouren

Promise<void>

getAllowedFieldValues(string)

Hiermee haalt u de toegestane waarden op voor het veld voor het actieve werkitem.

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

Parameters

fieldReferenceName

string

Veldreferentienaam

Retouren

Promise<Object[]>

Een promise die een matrix met toegestane waarden retourneert.

getDirtyFields(boolean)

Hiermee haalt u velden op die zijn gewijzigd door de gebruiker of door een werkitemregel en die een vervuilde status hebben.

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

Parameters

includeSystemChanges

boolean

Een booleaanse waarde die aangeeft of het resultaat wijzigingen moet bevatten die zijn ingesteld door werkitemregels.

Retouren

Promise<WorkItemField[]>

Een belofte die een matrix met velden voor vuile werkitems retourneert.

getFields()

Hiermee haalt u actieve werkitemvelden op.

function getFields(): Promise<WorkItemField[]>

Retouren

Promise<WorkItemField[]>

Een belofte die een veld met werkitems retourneert.

getFieldValue(string, boolean)

Waarschuwing

Deze API is nu afgeschaft.

Please use options instead of returnOriginalValue

Hiermee wordt de veldwaarde van het actieve werkitem opgehaald.

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

Parameters

fieldReferenceName

string

Veldreferentienaam

returnOriginalValue

boolean

(Optioneel) Indien onwaar, worden niet-opgeslagen veldwaarden opgehaald. De standaardinstelling is onwaar.

Retouren

Promise<Object>

Een belofte die de waarde van het veld werkitem retourneert.

getFieldValue(string, WorkItemOptions)

Hiermee wordt de veldwaarde van het actieve werkitem opgehaald.

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

Parameters

fieldReferenceName

string

Veldreferentienaam

options

WorkItemOptions

opties voor werkitems

Retouren

Promise<Object>

Een belofte die de waarde van het veld werkitem retourneert.

getFieldValues(string[], boolean)

Waarschuwing

Deze API is nu afgeschaft.

Please use options instead of returnOriginalValue

Hiermee worden veldwaarden van het actieve werkitem opgehaald.

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

Parameters

fieldReferenceNames

string[]

Een reeks veldreferentienamen

returnOriginalValue

boolean

(Optioneel) Indien onwaar, worden niet-opgeslagen veldwaarden opgehaald. De standaardinstelling is onwaar.

Retouren

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

Een belofte die een woordenlijst met veldwaarden voor werkitems retourneert (refName aan waardenparen).

getFieldValues(string[], WorkItemOptions)

Hiermee worden veldwaarden van het actieve werkitem opgehaald.

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

Parameters

fieldReferenceNames

string[]

Een verzameling veldreferentienamen

options

WorkItemOptions

opties voor werkitems

Retouren

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

Een belofte die een woordenlijst met veldwaarden voor werkitems retourneert (refName aan waardenparen).

getId()

Hiermee wordt de id van het actieve werkitem opgehaald.

function getId(): Promise<number>

Retouren

Promise<number>

Een belofte die de actieve werkitem-id retourneert.

getIdentityFieldValue(string, WorkItemOptions)

Hiermee wordt de waarde van het identiteitsveld van het actieve werkitem opgehaald.

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

Parameters

fieldReferenceName

string

Veldreferentienaam

options

WorkItemOptions

opties voor werkitems

Retouren

Promise<IdentityRef>

Een belofte die de waarde van het veld werkitem retourneert.

getInvalidFields()

Hiermee haalt u velden op die een ongeldige status hebben volgens de regels voor werkitems. Deze velden moeten worden gewijzigd voordat het werkitem kan worden opgeslagen.

function getInvalidFields(): Promise<WorkItemField[]>

Retouren

Promise<WorkItemField[]>

Een belofte die een matrix met ongeldige werkitemvelden retourneert.

getRevision()

Hiermee haalt u de meest recente revisie van het actieve werkitem op.

function getRevision(): Promise<number>

Retouren

Promise<number>

Een belofte die de meest recente revisie-id van het actieve werkitem retourneert.

getWorkItemRelations()

Retourneert een matrix met werkitemkoppelingen naar andere werkitems of artefacten (bijvoorbeeld doorvoeringen, hyperlinks). Bijlage wordt momenteel niet ondersteund door deze functie.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Retouren

Promise<WorkItemRelation[]>

Een belofte die een matrix van werkitemrelaties van actief werkitem retourneert.

getWorkItemRelationTypes()

Retourneert een matrix met relatietypen voor werkitems.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Retouren

Promise<WorkItemRelationType[]>

Een belofte die een matrix met relatietypen voor werkitems retourneert.

getWorkItemResourceUrl(number)

Retourneert de REST API-URL van de opgegeven werkitemresource.

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

Parameters

workItemId

number

Id van het werkitem waarvoor de resource-URL is aangevraagd.

Retouren

Promise<string>

Een belofte die de aangevraagde resource-URL van het werkitem retourneert.

hasActiveWorkItem()

Retourneert true als het actieve werkitem beschikbaar is.

function hasActiveWorkItem(): Promise<boolean>

Retouren

Promise<boolean>

Een belofte die een booleaanse waarde retourneert, geeft aan of het actieve werkitem beschikbaar is.

isDirty()

Retourneert true als het actieve werkitem vuil is.

function isDirty(): Promise<boolean>

Retouren

Promise<boolean>

Een belofte die een booleaanse waarde retourneert, geeft aan of het actieve werkitem vuil is.

isNew()

Retourneert true als het actieve werkitem nieuw is.

function isNew(): Promise<boolean>

Retouren

Promise<boolean>

Een belofte die een booleaanse waarde retourneert, geeft aan of het actieve werkitem nieuw is.

isValid()

Retourneert true als de actieve werkitemvelden allemaal geldig zijn.

function isValid(): Promise<boolean>

Retouren

Promise<boolean>

Een belofte die een booleaanse waarde retourneert, geeft aan of alle veldwaarden geldig zijn.

refresh()

Hiermee vernieuwt u het actieve werkitem. De gebruiker wordt gevraagd of het werkitem vuil is.

function refresh(): Promise<void>

Retouren

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Hiermee verwijdert u koppelingen naar andere werkitems of artefacten (zoals doorvoeringen, hyperlinks) uit het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.

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

Parameters

workItemRelations

WorkItemRelation[]

Koppelingen naar werkitems die u wilt verwijderen.

Retouren

Promise<void>

Een loze belofte.

reset()

Stel eventuele wijzigingen in het actieve werkitem opnieuw in. De gebruiker wordt gevraagd dit te bevestigen.

function reset(): Promise<void>

Retouren

Promise<void>

save()

Hiermee slaat u het actieve werkitem op.

function save(): Promise<void>

Retouren

Promise<void>

Een belofte die wordt opgelost als het werkitem is opgeslagen en geweigerd als het mislukt.

setError(string)

Markeert het werkitem als ongeldig en schakel het opslaan van het werkitem in het formulier uit.

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

Parameters

errorMessage

string

Een aangepast foutbericht dat boven op het werkitemformulier wordt weergegeven.

Retouren

Promise<void>

setFieldValue(string, Object)

Hiermee stelt u de veldwaarde van het actieve werkitem in.

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

Parameters

fieldReferenceName

string

Veldreferentienaam

value

Object

Veldwaarde

Retouren

Promise<boolean>

Een belofte die een booleaanse waarde retourneert, geeft aan of de functie is voltooid.

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

Hiermee stelt u veldwaarden van het actieve werkitem in.

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

Parameters

fields

{[fieldName: string]: Object}

Een woordenlijst van veld refName/values

Retouren

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

Een belofte die een woordenlijst retourneert met resultaten van het bijwerken van veldwaarden (refName naar resultatenparen).