IWorkItemFormService interface

Pakket:

azure-devops-extension-api

Hostservice voor interactie met het momenteel actieve werkitemformulier (werkitem dat momenteel wordt weergegeven in de gebruikersinterface). De formulierservice is afhankelijk van de huidige context van het actieve werkitem. Zal een foutmelding genereren wanneer er geen open werkitem is.

Methoden

addWorkItemRelations(WorkItemRelation[])	Voegt links van een ander werkitem of artefact (bijv. commits, hyperlinks) toe aan het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.
beginSaveWorkItem(() => void, () => void)	@deprecated: Gebruik a.u.b. opslaan
clearError()	Hiermee wordt de fout gewist die is ingesteld door de setError-methode en wordt het opslaan van het werkitem in het formulier gedeblokkeerd.
getAllowedFieldValues(string)	Hiermee haalt u de toegestane waarden op voor het veld op het actieve werkitem.
getDirtyFields(boolean)	Hiermee haalt u velden op die zijn gewijzigd door de gebruiker of door een werkitemregel en die de status Vuil hebben.
getFields()	Hiermee haalt u actieve werkitemvelden op.
getFieldValue(string, boolean)	Hiermee haalt u de veldwaarde van het actieve werkitem op.
getFieldValue(string, WorkItemOptions)	Hiermee haalt u de veldwaarde van het actieve werkitem op.
getFieldValues(string[], boolean)	Haalt veldwaarden op van het actieve werkitem.
getFieldValues(string[], WorkItemOptions)	Haalt veldwaarden op van het actieve werkitem.
getId()	Haalt een ID op van een actief werkitem.
getIdentityFieldValue(string, WorkItemOptions)	Hiermee haalt u de waarde van het identiteitsveld van het actieve werkitem op.
getInvalidFields()	Hiermee haalt u velden op die de status ongeldig 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 commits, hyperlinks). Bijlage wordt momenteel niet ondersteund door deze functie.
getWorkItemRelationTypes()	Retourneert een matrix van 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 waar als het actieve werkitem vuil is.
isNew()	Geeft als resultaat waar als het actieve werkitem nieuw is.
isValid()	Geeft true als resultaat als de actieve werkitemvelden allemaal geldig zijn.
refresh()	Vernieuwt het actieve werkitem. Zal de gebruiker vragen als het werkitem vuil is.
removeWorkItemRelations(WorkItemRelation[])	Verwijdert koppelingen naar een ander werkitem of artefacten (bijvoorbeeld commits, hyperlinks) uit het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.
reset()	Reset eventuele wijzigingen in het actieve werkitem. Zal de gebruiker vragen om te bevestigen.
save()	Slaat het actieve werkitem op.
setError(string)	Hiermee wordt het werkitem als ongeldig gemarkeerd en wordt het opslaan van het werkitem op het formulier uitgeschakeld.
setFieldValue(string, Object)	Hiermee stelt u de veldwaarde van het actieve werkitem in.
setFieldValues({[fieldName: string]: Object})	Hiermee stelt u de veldwaarden van het actieve werkitem in.

Methodedetails

addWorkItemRelations(WorkItemRelation[])

Voegt links van een ander werkitem of artefact (bijv. commits, hyperlinks) toe aan het werkitem. Bijlage wordt momenteel niet ondersteund door deze functie.

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

Parameters

workItemRelations

WorkItemRelation[]

Koppelingen naar werkitems om toe te voegen.

Retouren

Promise<void>

Een loze belofte.

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

@deprecated: Gebruik a.u.b. opslaan

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

Parameters

successCallback

() => void

errorCallback

() => void

Retouren

Promise<void>

clearError()

Hiermee wordt de fout gewist die is ingesteld door de setError-methode en wordt het opslaan van het werkitem in het formulier gedeblokkeerd.

function clearError(): Promise<void>

Retouren

Promise<void>

getAllowedFieldValues(string)

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

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

Parameters

fieldReferenceName

string

Naam van veldverwijzing

Retouren

Promise<Object[]>

Een belofte die een matrix aan toegestane waarden retourneert.

getDirtyFields(boolean)

Hiermee haalt u velden op die zijn gewijzigd door de gebruiker of door een werkitemregel en die de status Vuil 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 reeks velden voor vuile werkitems retourneert.

getFields()

Hiermee haalt u actieve werkitemvelden op.

function getFields(): Promise<WorkItemField[]>

Retouren

Promise<WorkItemField[]>

Een belofte die een matrix met werkitemvelden retourneert.

getFieldValue(string, boolean)

Waarschuwing

Deze API is nu afgeschaft.

Please use options instead of returnOriginalValue

Hiermee haalt u de veldwaarde van het actieve werkitem op.

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

Parameters

fieldReferenceName

string

Naam van veldverwijzing

returnOriginalValue

boolean

(Optioneel) Als onwaar, worden niet-opgeslagen veldwaarden opgehaald. De standaardwaarde is vals.

Retouren

Promise<Object>

Een belofte die de waarde van het veld werkitem retourneert.

getFieldValue(string, WorkItemOptions)

Hiermee haalt u de veldwaarde van het actieve werkitem op.

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

Parameters

fieldReferenceName

string

Naam van veldverwijzing

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

Haalt veldwaarden op van het actieve werkitem.

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

Parameters

fieldReferenceNames

string[]

Een arsenaal aan namen van veldverwijzingen

returnOriginalValue

boolean

(Optioneel) Als onwaar, worden niet-opgeslagen veldwaarden opgehaald. De standaardwaarde is vals.

Retouren

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

Een belofte die een woordenlijst met veldwaarden voor werkitems retourneert (verwijsNaam naar waardenparen).

getFieldValues(string[], WorkItemOptions)

Haalt veldwaarden op van het actieve werkitem.

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

Parameters

fieldReferenceNames

string[]

Een arsenaal aan namen van veldverwijzingen

options

WorkItemOptions

Opties voor werkitems

Retouren

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

Een belofte die een woordenlijst met veldwaarden voor werkitems retourneert (verwijsNaam naar waardenparen).

getId()

Haalt een ID op van een actief werkitem.

function getId(): Promise<number>

Retouren

Promise<number>

Een belofte die de actieve werkitem-id retourneert.

getIdentityFieldValue(string, WorkItemOptions)

Hiermee haalt u de waarde van het identiteitsveld van het actieve werkitem op.

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

Parameters

fieldReferenceName

string

Naam van veldverwijzing

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 de status ongeldig 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 commits, hyperlinks). Bijlage wordt momenteel niet ondersteund door deze functie.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Retouren

Promise<WorkItemRelation[]>

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

getWorkItemRelationTypes()

Retourneert een matrix van relatietypen voor werkitems.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Retouren

Promise<WorkItemRelationType[]>

Een belofte die een matrix van 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 bron-URL wordt 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 waar 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()

Geeft als resultaat waar 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()

Geeft true als resultaat 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()

Vernieuwt het actieve werkitem. Zal de gebruiker vragen als het werkitem vuil is.

function refresh(): Promise<void>

Retouren

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Verwijdert koppelingen naar een ander werkitem of artefacten (bijvoorbeeld commits, 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()

Reset eventuele wijzigingen in het actieve werkitem. Zal de gebruiker vragen om te bevestigen.

function reset(): Promise<void>

Retouren

Promise<void>

save()

Slaat het actieve werkitem op.

function save(): Promise<void>

Retouren

Promise<void>

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

setError(string)

Hiermee wordt het werkitem als ongeldig gemarkeerd en wordt het opslaan van het werkitem op het formulier uitgeschakeld.

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

Parameters

errorMessage

string

Een aangepast foutbericht dat boven aan 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

Naam van veldverwijzing

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 de veldwaarden van het actieve werkitem in.

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

Parameters

fields

{[fieldName: string]: Object}

Een woordenlijst met velden refName/values

Retouren

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

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