IWorkItemFormService interface

Paket:

azure-devops-extension-api

Hostdienst für die Interaktion mit dem aktuell aktiven Arbeitsaufgabenformular (Arbeitsaufgabe, die derzeit auf der Benutzeroberfläche angezeigt wird). Der Formulardienst hängt vom aktuell aktiven Arbeitsaufgabenkontext ab. Löst einen Fehler aus, wenn keine offene Arbeitsaufgabe vorhanden ist.

Methoden

addWorkItemRelations(WorkItemRelation[])	Fügt der Arbeitsaufgabe Links anderer Arbeitsaufgaben oder Artefakte (z. B. Commits, Hyperlinks) hinzu. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.
beginSaveWorkItem(() => void, () => void)	@deprecated: Bitte verwenden Sie Speichern
clearError()	Löscht den von der setError-Methode festgelegten Fehler und hebt die Blockierung des Speicherns der Arbeitsaufgabe im Formular auf.
getAllowedFieldValues(string)	Ruft die zulässigen Werte für das Feld für die aktive Arbeitsaufgabe ab.
getDirtyFields(boolean)	Ruft Felder ab, die entweder vom Benutzer oder von einer Arbeitsaufgabenregel geändert wurden und sich in einem geänderten Zustand befinden.
getFields()	Ruft aktive Arbeitsaufgabenfelder ab.
getFieldValue(string, boolean)	Ruft den Feldwert der aktiven Arbeitsaufgabe ab.
getFieldValue(string, WorkItemOptions)	Ruft den Feldwert der aktiven Arbeitsaufgabe ab.
getFieldValues(string[], boolean)	Ruft die Feldwerte der aktiven Arbeitsaufgabe ab.
getFieldValues(string[], WorkItemOptions)	Ruft die Feldwerte der aktiven Arbeitsaufgabe ab.
getId()	Ruft die ID der aktiven Arbeitsaufgabe ab.
getIdentityFieldValue(string, WorkItemOptions)	Ruft den Wert des Identitätsfelds der aktiven Arbeitsaufgabe ab.
getInvalidFields()	Ruft Felder ab, die sich gemäß den Arbeitsaufgabenregeln in einem ungültigen Zustand befinden. Diese Felder müssen geändert werden, bevor die Arbeitsaufgabe gespeichert werden kann.
getRevision()	Ruft die neueste Version der aktiven Arbeitsaufgabe ab.
getWorkItemRelations()	Gibt ein Array von Arbeitsaufgabenlinks zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) zurück. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.
getWorkItemRelationTypes()	Gibt ein Array von Arbeitsaufgabenbeziehungstypen zurück.
getWorkItemResourceUrl(number)	Gibt die REST-API-URL der angegebenen Arbeitselementressource zurück.
hasActiveWorkItem()	Gibt true zurück, wenn die aktive Arbeitsaufgabe verfügbar ist.
isDirty()	Gibt true zurück, wenn die aktive Arbeitsaufgabe geändert ist.
isNew()	Gibt true zurück, wenn die aktive Arbeitsaufgabe neu ist.
isValid()	Gibt true zurück, wenn alle aktiven Arbeitsaufgabenfelder gültig sind.
refresh()	Aktualisiert die aktive Arbeitsaufgabe. Fordert den Benutzer auf, wenn die Arbeitsaufgabe geändert ist.
removeWorkItemRelations(WorkItemRelation[])	Entfernt Links zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) aus der Arbeitsaufgabe. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.
reset()	Setzen Sie alle Änderungen in der aktiven Arbeitsaufgabe zurück. Fordert den Benutzer zur Bestätigung auf.
save()	Speichert die aktive Arbeitsaufgabe.
setError(string)	Markiert die Arbeitsaufgabe als ungültig und deaktiviert das Speichern der Arbeitsaufgabe im Formular.
setFieldValue(string, Object)	Legt den Feldwert der aktiven Arbeitsaufgabe fest.
setFieldValues({[fieldName: string]: Object})	Legt die Feldwerte der aktiven Arbeitsaufgabe fest.

Details zur Methode

addWorkItemRelations(WorkItemRelation[])

Fügt der Arbeitsaufgabe Links anderer Arbeitsaufgaben oder Artefakte (z. B. Commits, Hyperlinks) hinzu. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.

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

Parameter

workItemRelations

WorkItemRelation[]

Hinzuzufügende Arbeitselementlinks.

Gibt zurück

Promise<void>

Ein leeres Versprechen.

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

@deprecated: Bitte verwenden Sie Speichern

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

Parameter

successCallback

() => void

errorCallback

() => void

Gibt zurück

Promise<void>

clearError()

Löscht den von der setError-Methode festgelegten Fehler und hebt die Blockierung des Speicherns der Arbeitsaufgabe im Formular auf.

function clearError(): Promise<void>

Gibt zurück

Promise<void>

getAllowedFieldValues(string)

Ruft die zulässigen Werte für das Feld für die aktive Arbeitsaufgabe ab.

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

Parameter

fieldReferenceName

string

Name der Feldreferenz

Gibt zurück

Promise<Object[]>

Eine Zusage, die ein Array zulässiger Werte zurückgibt.

getDirtyFields(boolean)

Ruft Felder ab, die entweder vom Benutzer oder von einer Arbeitsaufgabenregel geändert wurden und sich in einem geänderten Zustand befinden.

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

Parameter

includeSystemChanges

boolean

Ein boolescher Wert, der angibt, ob das Ergebnis Änderungen enthalten soll, die von Arbeitsaufgabenregeln festgelegt wurden.

Gibt zurück

Promise<WorkItemField[]>

Eine Zusage, die ein Array von überprüften Arbeitselementfeldern zurückgibt.

getFields()

Ruft aktive Arbeitsaufgabenfelder ab.

function getFields(): Promise<WorkItemField[]>

Gibt zurück

Promise<WorkItemField[]>

Eine Zusage, die ein Array des Arbeitsaufgabenfelds zurückgibt.

getFieldValue(string, boolean)

Warnung

Diese API ist nun veraltet.

Please use options instead of returnOriginalValue

Ruft den Feldwert der aktiven Arbeitsaufgabe ab.

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

Parameter

fieldReferenceName

string

Name der Feldreferenz

returnOriginalValue

boolean

(Fakultativ) Wenn false, werden nicht gespeicherte Feldwerte abgerufen. Der Standardwert ist "false".

Gibt zurück

Promise<Object>

Eine Zusage, die den Wert des Arbeitsaufgabenfelds zurückgibt.

getFieldValue(string, WorkItemOptions)

Ruft den Feldwert der aktiven Arbeitsaufgabe ab.

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

Parameter

fieldReferenceName

string

Name der Feldreferenz

options

WorkItemOptions

Optionen für Arbeitsaufgaben

Gibt zurück

Promise<Object>

Eine Zusage, die den Wert des Arbeitsaufgabenfelds zurückgibt.

getFieldValues(string[], boolean)

Warnung

Diese API ist nun veraltet.

Please use options instead of returnOriginalValue

Ruft die Feldwerte der aktiven Arbeitsaufgabe ab.

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

Parameter

fieldReferenceNames

string[]

Eine Reihe von Feldreferenznamen

returnOriginalValue

boolean

(Fakultativ) Wenn false, werden nicht gespeicherte Feldwerte abgerufen. Der Standardwert ist "false".

Gibt zurück

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

Eine Zusage, die ein Wörterbuch mit Arbeitsaufgabenfeldwerten (refName in Wertepaare) zurückgibt.

getFieldValues(string[], WorkItemOptions)

Ruft die Feldwerte der aktiven Arbeitsaufgabe ab.

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

Parameter

fieldReferenceNames

string[]

Eine Reihe von Feldreferenznamen

options

WorkItemOptions

Optionen für Arbeitsaufgaben

Gibt zurück

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

Eine Zusage, die ein Wörterbuch mit Arbeitsaufgabenfeldwerten (refName in Wertepaare) zurückgibt.

getId()

Ruft die ID der aktiven Arbeitsaufgabe ab.

function getId(): Promise<number>

Gibt zurück

Promise<number>

Eine Zusage, die die aktive Arbeitsaufgaben-ID zurückgibt.

getIdentityFieldValue(string, WorkItemOptions)

Ruft den Wert des Identitätsfelds der aktiven Arbeitsaufgabe ab.

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

Parameter

fieldReferenceName

string

Name der Feldreferenz

options

WorkItemOptions

Optionen für Arbeitsaufgaben

Gibt zurück

Promise<IdentityRef>

Eine Zusage, die den Wert des Arbeitsaufgabenfelds zurückgibt.

getInvalidFields()

Ruft Felder ab, die sich gemäß den Arbeitsaufgabenregeln in einem ungültigen Zustand befinden. Diese Felder müssen geändert werden, bevor die Arbeitsaufgabe gespeichert werden kann.

function getInvalidFields(): Promise<WorkItemField[]>

Gibt zurück

Promise<WorkItemField[]>

Eine Zusage, die ein Array ungültiger Arbeitsaufgabenfelder zurückgibt.

getRevision()

Ruft die neueste Version der aktiven Arbeitsaufgabe ab.

function getRevision(): Promise<number>

Gibt zurück

Promise<number>

Eine Zusage, die die letzte Revisions-ID der aktiven Arbeitsaufgabe zurückgibt.

getWorkItemRelations()

Gibt ein Array von Arbeitsaufgabenlinks zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) zurück. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Gibt zurück

Promise<WorkItemRelation[]>

Eine Zusage, die ein Array von Arbeitsaufgabenbeziehungen der aktiven Arbeitsaufgabe zurückgibt.

getWorkItemRelationTypes()

Gibt ein Array von Arbeitsaufgabenbeziehungstypen zurück.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Gibt zurück

Promise<WorkItemRelationType[]>

Eine Zusage, die ein Array von Arbeitsaufgabenbeziehungstypen zurückgibt.

getWorkItemResourceUrl(number)

Gibt die REST-API-URL der angegebenen Arbeitselementressource zurück.

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

Parameter

workItemId

number

ID der Arbeitsaufgabe, für die die Ressourcen-URL angefordert wird.

Gibt zurück

Promise<string>

Eine Zusage, die die angeforderte Ressourcen-URL der Arbeitsaufgabe zurückgibt.

hasActiveWorkItem()

Gibt true zurück, wenn die aktive Arbeitsaufgabe verfügbar ist.

function hasActiveWorkItem(): Promise<boolean>

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob die aktive Arbeitsaufgabe verfügbar ist.

isDirty()

Gibt true zurück, wenn die aktive Arbeitsaufgabe geändert ist.

function isDirty(): Promise<boolean>

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob die aktive Arbeitsaufgabe geändert ist.

isNew()

Gibt true zurück, wenn die aktive Arbeitsaufgabe neu ist.

function isNew(): Promise<boolean>

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob die aktive Arbeitsaufgabe neu ist.

isValid()

Gibt true zurück, wenn alle aktiven Arbeitsaufgabenfelder gültig sind.

function isValid(): Promise<boolean>

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob alle Feldwerte gültig sind.

refresh()

Aktualisiert die aktive Arbeitsaufgabe. Fordert den Benutzer auf, wenn die Arbeitsaufgabe geändert ist.

function refresh(): Promise<void>

Gibt zurück

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Entfernt Links zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) aus der Arbeitsaufgabe. Das Anhängen wird von dieser Funktion derzeit nicht unterstützt.

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

Parameter

workItemRelations

WorkItemRelation[]

Zu entfernende Arbeitsaufgabenlinks.

Gibt zurück

Promise<void>

Ein leeres Versprechen.

reset()

Setzen Sie alle Änderungen in der aktiven Arbeitsaufgabe zurück. Fordert den Benutzer zur Bestätigung auf.

function reset(): Promise<void>

Gibt zurück

Promise<void>

save()

Speichert die aktive Arbeitsaufgabe.

function save(): Promise<void>

Gibt zurück

Promise<void>

Eine Zusage, die aufgelöst wird, wenn die Arbeitsaufgabe erfolgreich gespeichert wird, und abgelehnt wird, wenn sie fehlschlägt.

setError(string)

Markiert die Arbeitsaufgabe als ungültig und deaktiviert das Speichern der Arbeitsaufgabe im Formular.

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

Parameter

errorMessage

string

Eine benutzerdefinierte Fehlermeldung, die über dem Arbeitsaufgabenformular angezeigt wird.

Gibt zurück

Promise<void>

setFieldValue(string, Object)

Legt den Feldwert der aktiven Arbeitsaufgabe fest.

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

Parameter

fieldReferenceName

string

Name der Feldreferenz

value

Object

Feldwert

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob die Funktion erfolgreich abgeschlossen wurde.

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

Legt die Feldwerte der aktiven Arbeitsaufgabe fest.

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

Parameter

fields

{[fieldName: string]: Object}

Ein Wörterbuch mit Feldern refName/values

Gibt zurück

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

Eine Zusage, die ein Wörterbuch mit Ergebnissen zur Aktualisierung von Feldwerten (refName in Ergebnispaare) zurückgibt.