IWorkItemFormService interface

Paket:

azure-devops-extension-api

Hostdienst für die Interaktion mit dem aktuell aktiven Arbeitselementformular (Arbeitselement wird derzeit auf der Benutzeroberfläche angezeigt). Der Formulardienst hängt vom aktuellen aktiven Arbeitselementkontext ab. Löst einen Fehler aus, wenn kein arbeitselement geöffnet ist.

Methoden

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

Details zur Methode

addWorkItemRelations(WorkItemRelation[])

Fügt dem Arbeitselement Links zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) hinzu. Anlage 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>

Eine leere Zusage.

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

@deprecated: Bitte speichern verwenden

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 Arbeitselements 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 das aktive Arbeitselement ab.

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

Parameter

fieldReferenceName

string

Feldverweisname

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 Arbeitselementregel geändert wurden und sich in einem modifiziert Zustand befinden.

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

Parameter

includeSystemChanges

boolean

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

Gibt zurück

Promise<WorkItemField[]>

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

getFields()

Ruft aktive Arbeitselementfelder ab.

function getFields(): Promise<WorkItemField[]>

Gibt zurück

Promise<WorkItemField[]>

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

getFieldValue(string, boolean)

Warnung

Diese API ist nun veraltet.

Please use options instead of returnOriginalValue

Ruft den Feldwert des aktiven Arbeitselements ab.

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

Parameter

fieldReferenceName

string

Feldverweisname

returnOriginalValue

boolean

(Optional) Wenn false, ruft nicht gespeicherte Feldwerte ab. Der Standardwert ist "false".

Gibt zurück

Promise<Object>

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

getFieldValue(string, WorkItemOptions)

Ruft den Feldwert des aktiven Arbeitselements ab.

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

Parameter

fieldReferenceName

string

Feldverweisname

options

WorkItemOptions

Arbeitselementoptionen

Gibt zurück

Promise<Object>

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

getFieldValues(string[], boolean)

Warnung

Diese API ist nun veraltet.

Please use options instead of returnOriginalValue

Ruft Feldwerte des aktiven Arbeitselements ab.

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

Parameter

fieldReferenceNames

string[]

Eine Reihe von Feldverweisnamen

returnOriginalValue

boolean

(Optional) Wenn false, ruft nicht gespeicherte Feldwerte ab. Der Standardwert ist "false".

Gibt zurück

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

Eine Zusage, die ein Wörterbuch von Arbeitselementfeldwerten zurückgibt (refName zu Wertepaaren).

getFieldValues(string[], WorkItemOptions)

Ruft Feldwerte des aktiven Arbeitselements ab.

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

Parameter

fieldReferenceNames

string[]

Eine Reihe von Feldverweisnamen

options

WorkItemOptions

Arbeitselementoptionen

Gibt zurück

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

Eine Zusage, die ein Wörterbuch von Arbeitselementfeldwerten zurückgibt (refName zu Wertepaaren).

getId()

Ruft die ID des aktiven Arbeitselements ab.

function getId(): Promise<number>

Gibt zurück

Promise<number>

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

getIdentityFieldValue(string, WorkItemOptions)

Ruft den Identitätsfeldwert des aktiven Arbeitselements ab.

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

Parameter

fieldReferenceName

string

Feldverweisname

options

WorkItemOptions

Arbeitselementoptionen

Gibt zurück

Promise<IdentityRef>

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

getInvalidFields()

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

function getInvalidFields(): Promise<WorkItemField[]>

Gibt zurück

Promise<WorkItemField[]>

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

getRevision()

Ruft die neueste Revision des aktiven Arbeitselements ab.

function getRevision(): Promise<number>

Gibt zurück

Promise<number>

Eine Zusage, die die neueste Revisions-ID des aktiven Arbeitselements zurückgibt.

getWorkItemRelations()

Gibt ein Array von Arbeitselementlinks zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) zurück. Anlage wird von dieser Funktion derzeit nicht unterstützt.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Gibt zurück

Promise<WorkItemRelation[]>

Eine Zusage, die ein Array von Arbeitselementbeziehungen des aktiven Arbeitselements zurückgibt.

getWorkItemRelationTypes()

Gibt ein Array von Arbeitselementbeziehungstypen zurück.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Gibt zurück

Promise<WorkItemRelationType[]>

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

getWorkItemResourceUrl(number)

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

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

Parameter

workItemId

number

ID des Arbeitselements, für das die Ressourcen-URL angefordert wird.

Gibt zurück

Promise<string>

Eine Zusage, die die angeforderte Ressourcen-URL des Arbeitselements zurückgibt.

hasActiveWorkItem()

Gibt true zurück, wenn das aktive Arbeitselement verfügbar ist.

function hasActiveWorkItem(): Promise<boolean>

Gibt zurück

Promise<boolean>

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

isDirty()

Gibt true zurück, wenn das aktive Arbeitselement modifiziert ist.

function isDirty(): Promise<boolean>

Gibt zurück

Promise<boolean>

Eine Zusage, die einen booleschen Wert zurückgibt, gibt an, ob das aktive Arbeitselement modifiziert ist.

isNew()

Gibt true zurück, wenn das aktive Arbeitselement neu ist.

function isNew(): Promise<boolean>

Gibt zurück

Promise<boolean>

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

isValid()

Gibt true zurück, wenn die aktiven Arbeitselementfelder alle 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 das aktive Arbeitselement. Fordert den Benutzer auf, ob das Arbeitselement modifiziert ist.

function refresh(): Promise<void>

Gibt zurück

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Entfernt Links zu anderen Arbeitselementen oder Artefakten (z. B. Commits, Hyperlinks) aus dem Arbeitselement. Anlage wird von dieser Funktion derzeit nicht unterstützt.

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

Parameter

workItemRelations

WorkItemRelation[]

Zu entfernende Arbeitselementlinks.

Gibt zurück

Promise<void>

Eine leere Zusage.

reset()

Setzen Sie alle Änderungen im aktiven Arbeitselement zurück. Fordert den Benutzer zur Bestätigung auf.

function reset(): Promise<void>

Gibt zurück

Promise<void>

save()

Speichert das aktive Arbeitselement.

function save(): Promise<void>

Gibt zurück

Promise<void>

Eine Zusage, die aufgelöst wird, wenn das Arbeitselement erfolgreich gespeichert und abgelehnt wird, wenn es fehlschlägt.

setError(string)

Markiert das Arbeitselement als ungültig und deaktiviert das Speichern des Arbeitselements im Formular.

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

Parameter

errorMessage

string

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

Gibt zurück

Promise<void>

setFieldValue(string, Object)

Legt den Feldwert des aktiven Arbeitselements fest.

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

Parameter

fieldReferenceName

string

Feldverweisname

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 Feldwerte des aktiven Arbeitselements fest.

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

Parameter

fields

{[fieldName: string]: Object}

Ein Wörterbuch mit feld refName/values

Gibt zurück

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

Eine Zusage, die ein Wörterbuch der Ergebnisse der Aktualisierung von Feldwerten zurückgibt (refName zu Ergebnispaaren).