IWorkItemFormService interface

Paket:

azure-devops-extension-api

Värdtjänst för att interagera med det aktiva arbetsobjektsformuläret (arbetsobjekt som för närvarande visas i användargränssnittet). Formulärtjänsten är beroende av den aktuella kontexten för det aktiva arbetsobjektet. Genererar ett fel när det inte finns något öppet arbetsobjekt.

Metoder

addWorkItemRelations(WorkItemRelation[])	Lägger till länkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar) i arbetsobjektet. Bifogad fil stöds för närvarande inte av den här funktionen.
beginSaveWorkItem(() => void, () => void)	@deprecated: Använd spara
clearError()	Rensar felet som angetts av setError-metoden och avblockerar sparandet av arbetsobjektet i formuläret.
getAllowedFieldValues(string)	Hämtar de tillåtna värdena för fältet i det aktiva arbetsobjektet.
getDirtyFields(boolean)	Hämtar fält som har ändrats antingen av användaren eller av en regel för arbetsobjekt och som är i ett smutsigt tillstånd.
getFields()	Hämtar aktiva arbetsobjektfält.
getFieldValue(string, boolean)	Hämtar fältvärdet för det aktiva arbetsobjektet.
getFieldValue(string, WorkItemOptions)	Hämtar fältvärdet för det aktiva arbetsobjektet.
getFieldValues(string[], boolean)	Hämtar fältvärden för det aktiva arbetsobjektet.
getFieldValues(string[], WorkItemOptions)	Hämtar fältvärden för det aktiva arbetsobjektet.
getId()	Hämtar ID för aktivt arbetsobjekt.
getIdentityFieldValue(string, WorkItemOptions)	Hämtar identitetsfältvärdet för det aktiva arbetsobjektet.
getInvalidFields()	Hämtar fält som är i ett ogiltigt tillstånd enligt arbetsobjektsreglerna. Dessa fält måste ändras innan arbetsobjektet kan sparas.
getRevision()	Hämtar den senaste revisionen av det aktiva arbetsobjektet.
getWorkItemRelations()	Returnerar en matris med arbetsobjektlänkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar). Bifogad fil stöds för närvarande inte av den här funktionen.
getWorkItemRelationTypes()	Returnerar en matris med relationstyper för arbetsobjekt.
getWorkItemResourceUrl(number)	Returnerar REST API-URL:en för den angivna arbetsobjektresursen.
hasActiveWorkItem()	Returnerar "true" om det aktiva arbetsobjektet är tillgängligt.
isDirty()	Returnerar "true" om det aktiva arbetsobjektet är smutsigt.
isNew()	Returnerar "true" om det aktiva arbetsobjektet är nytt.
isValid()	Returnerar "true" om alla aktiva arbetsobjektfält är giltiga.
refresh()	Uppdaterar det aktiva arbetsobjektet. Frågar användaren om arbetsobjektet är smutsigt.
removeWorkItemRelations(WorkItemRelation[])	Tar bort länkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar) från arbetsobjektet. Bifogad fil stöds för närvarande inte av den här funktionen.
reset()	Återställ eventuella ändringar i det aktiva arbetsobjektet. Kommer att uppmana användaren att bekräfta.
save()	Sparar det aktiva arbetsobjektet.
setError(string)	Markerar arbetsobjektet som ogiltigt och inaktiverar sparande av arbetsobjektet i formuläret.
setFieldValue(string, Object)	Anger fältvärdet för det aktiva arbetsobjektet.
setFieldValues({[fieldName: string]: Object})	Anger fältvärden för det aktiva arbetsobjektet.

Metodinformation

addWorkItemRelations(WorkItemRelation[])

Lägger till länkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar) i arbetsobjektet. Bifogad fil stöds för närvarande inte av den här funktionen.

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

Parametrar

workItemRelations

WorkItemRelation[]

Länkar till arbetsobjekt som ska läggas till.

Returer

Promise<void>

Ett tomt löfte.

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

@deprecated: Använd spara

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

Parametrar

successCallback

() => void

errorCallback

() => void

Returer

Promise<void>

clearError()

Rensar felet som angetts av setError-metoden och avblockerar sparandet av arbetsobjektet i formuläret.

function clearError(): Promise<void>

Returer

Promise<void>

getAllowedFieldValues(string)

Hämtar de tillåtna värdena för fältet i det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceName

string

Namn på fältreferens

Returer

Promise<Object[]>

Ett löfte som returnerar en matris med tillåtna värden.

getDirtyFields(boolean)

Hämtar fält som har ändrats antingen av användaren eller av en regel för arbetsobjekt och som är i ett smutsigt tillstånd.

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

Parametrar

includeSystemChanges

boolean

Ett booleskt värde som anger om resultatet ska innehålla ändringar som angetts av regler för arbetsobjekt.

Returer

Promise<WorkItemField[]>

Ett löfte som returnerar en matris med fält för smutsigt arbetsobjekt.

getFields()

Hämtar aktiva arbetsobjektfält.

function getFields(): Promise<WorkItemField[]>

Returer

Promise<WorkItemField[]>

Ett löfte som returnerar en matris med arbetsobjektfält.

getFieldValue(string, boolean)

Varning

Det här API:et är nu inaktuellt.

Please use options instead of returnOriginalValue

Hämtar fältvärdet för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceName

string

Namn på fältreferens

returnOriginalValue

boolean

(Valfritt) Om det är falskt hämtas fältvärden som inte har sparats. Standardvärdet är false.

Returer

Promise<Object>

Ett löfte som returnerar värdet för arbetsobjektfältet.

getFieldValue(string, WorkItemOptions)

Hämtar fältvärdet för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceName

string

Namn på fältreferens

options

WorkItemOptions

Alternativ för arbetsobjekt

Returer

Promise<Object>

Ett löfte som returnerar värdet för arbetsobjektfältet.

getFieldValues(string[], boolean)

Varning

Det här API:et är nu inaktuellt.

Please use options instead of returnOriginalValue

Hämtar fältvärden för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceNames

string[]

En mängd fältreferensnamn

returnOriginalValue

boolean

(Valfritt) Om det är falskt hämtas fältvärden som inte har sparats. Standardvärdet är false.

Returer

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

Ett löfte som returnerar en ordlista med fältvärden för arbetsobjekt (refName till värdepar).

getFieldValues(string[], WorkItemOptions)

Hämtar fältvärden för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceNames

string[]

En mängd fältreferensnamn

options

WorkItemOptions

Alternativ för arbetsobjekt

Returer

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

Ett löfte som returnerar en ordlista med fältvärden för arbetsobjekt (refName till värdepar).

getId()

Hämtar ID för aktivt arbetsobjekt.

function getId(): Promise<number>

Returer

Promise<number>

Ett löfte som returnerar det aktiva arbetsobjektets ID.

getIdentityFieldValue(string, WorkItemOptions)

Hämtar identitetsfältvärdet för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceName

string

Namn på fältreferens

options

WorkItemOptions

Alternativ för arbetsobjekt

Returer

Promise<IdentityRef>

Ett löfte som returnerar värdet för arbetsobjektfältet.

getInvalidFields()

Hämtar fält som är i ett ogiltigt tillstånd enligt arbetsobjektsreglerna. Dessa fält måste ändras innan arbetsobjektet kan sparas.

function getInvalidFields(): Promise<WorkItemField[]>

Returer

Promise<WorkItemField[]>

Ett löfte som returnerar en matris med ogiltiga arbetsobjektfält.

getRevision()

Hämtar den senaste revisionen av det aktiva arbetsobjektet.

function getRevision(): Promise<number>

Returer

Promise<number>

Ett löfte som returnerar det aktiva arbetsobjektets senaste revisions-ID.

getWorkItemRelations()

Returnerar en matris med arbetsobjektlänkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar). Bifogad fil stöds för närvarande inte av den här funktionen.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Returer

Promise<WorkItemRelation[]>

Ett löfte som returnerar en matris med arbetsobjektrelationer för aktiva arbetsobjekt.

getWorkItemRelationTypes()

Returnerar en matris med relationstyper för arbetsobjekt.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Returer

Promise<WorkItemRelationType[]>

Ett löfte som returnerar en matris med relationstyper för arbetsobjekt.

getWorkItemResourceUrl(number)

Returnerar REST API-URL:en för den angivna arbetsobjektresursen.

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

Parametrar

workItemId

number

ID för det arbetsobjekt som resurs-URL:en begärs för.

Returer

Promise<string>

Ett löfte som returnerar den begärda resurs-URL:en för arbetsobjektet.

hasActiveWorkItem()

Returnerar "true" om det aktiva arbetsobjektet är tillgängligt.

function hasActiveWorkItem(): Promise<boolean>

Returer

Promise<boolean>

Ett löfte som returnerar ett booleskt värde anger om det aktiva arbetsobjektet är tillgängligt.

isDirty()

Returnerar "true" om det aktiva arbetsobjektet är smutsigt.

function isDirty(): Promise<boolean>

Returer

Promise<boolean>

Ett löfte som returnerar ett booleskt värde anger om det aktiva arbetsobjektet är smutsigt.

isNew()

Returnerar "true" om det aktiva arbetsobjektet är nytt.

function isNew(): Promise<boolean>

Returer

Promise<boolean>

Ett löfte som returnerar ett booleskt värde anger om det aktiva arbetsobjektet är nytt.

isValid()

Returnerar "true" om alla aktiva arbetsobjektfält är giltiga.

function isValid(): Promise<boolean>

Returer

Promise<boolean>

Ett löfte som returnerar ett booleskt värde anger om alla fältvärden är giltiga.

refresh()

Uppdaterar det aktiva arbetsobjektet. Frågar användaren om arbetsobjektet är smutsigt.

function refresh(): Promise<void>

Returer

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Tar bort länkar till andra arbetsobjekt eller artefakter (t.ex. incheckningar, hyperlänkar) från arbetsobjektet. Bifogad fil stöds för närvarande inte av den här funktionen.

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

Parametrar

workItemRelations

WorkItemRelation[]

Länkar till arbetsobjekt som ska tas bort.

Returer

Promise<void>

Ett tomt löfte.

reset()

Återställ eventuella ändringar i det aktiva arbetsobjektet. Kommer att uppmana användaren att bekräfta.

function reset(): Promise<void>

Returer

Promise<void>

save()

Sparar det aktiva arbetsobjektet.

function save(): Promise<void>

Returer

Promise<void>

Ett löfte som löses om arbetsobjektet sparas och avvisas om det misslyckas.

setError(string)

Markerar arbetsobjektet som ogiltigt och inaktiverar sparande av arbetsobjektet i formuläret.

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

Parametrar

errorMessage

string

Ett anpassat felmeddelande som visas ovanpå arbetsobjektsformuläret.

Returer

Promise<void>

setFieldValue(string, Object)

Anger fältvärdet för det aktiva arbetsobjektet.

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

Parametrar

fieldReferenceName

string

Namn på fältreferens

value

Object

Fältvärde

Returer

Promise<boolean>

Ett löfte som returnerar ett booleskt värde anger om funktionen har slutförts.

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

Anger fältvärden för det aktiva arbetsobjektet.

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

Parametrar

fields

{[fieldName: string]: Object}

En ordlista med fält refName/values

Returer

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

Ett löfte som returnerar en ordlista med uppdateringsresultat för fältvärden (refName till resultatpar).