IWorkItemFormService interface

Csomag:

azure-devops-extension-api

Gazdaszolgáltatás az aktuálisan aktív munkaelem-űrlappal való interakcióhoz (a felhasználói felületen jelenleg megjelenő munkaelem). Az űrlapszolgáltatás az aktuális aktív munkaelem-környezettől függ. Hibaüzenet jelenik meg, ha nincs megnyitott munkaelem.

Metódusok

addWorkItemRelations(WorkItemRelation[])	Más munkaelemekre vagy összetevőkre (például véglegesítésekre, hivatkozásokra) mutató hivatkozásokat ad hozzá a munkaelemhez. A függvény jelenleg nem támogatja a mellékletet.
beginSaveWorkItem(() => void, () => void)	@deprecated: Használja a mentést
clearError()	Törli a setError metódus által beállított hibát, és feloldja a munkaelem mentésének letiltását az űrlapon.
getAllowedFieldValues(string)	Lekéri az aktív munkaelem mezőjének engedélyezett értékeit.
getDirtyFields(boolean)	Beolvashatja azokat a mezőket, amelyeket felhasználó vagy munkaelem-szabály módosított, és amelyek piszkos állapotban vannak.
getFields()	Lekéri az aktív munkaelemmezőket.
getFieldValue(string, boolean)	Lekéri az aktív munkaelem mezőértékét.
getFieldValue(string, WorkItemOptions)	Lekéri az aktív munkaelem mezőértékét.
getFieldValues(string[], boolean)	Lekéri az aktív munkaelem mezőértékét.
getFieldValues(string[], WorkItemOptions)	Lekéri az aktív munkaelem mezőértékét.
getId()	Lekéri az aktív munkaelem azonosítóját.
getIdentityFieldValue(string, WorkItemOptions)	Lekéri az aktív munkaelem identitásmező-értékét.
getInvalidFields()	Azokat a mezőket kapja meg, amelyek a munkaelem-szabályok szerint érvénytelen állapotban vannak. Ezeket a mezőket módosítani kell a munkaelem mentése előtt.
getRevision()	Lekéri az aktív munkaelem legújabb változatát.
getWorkItemRelations()	Munkaelem-hivatkozásokat tartalmazó tömböt ad vissza más munkaelemekhez vagy összetevőkhöz (például véglegesítésekhez, hivatkozásokhoz). A függvény jelenleg nem támogatja a mellékletet.
getWorkItemRelationTypes()	Munkaelem-relációs típusokat tartalmazó tömböt ad vissza.
getWorkItemResourceUrl(number)	A megadott munkaelem-erőforrás REST API-URL-címét adja vissza.
hasActiveWorkItem()	Igaz értéket ad vissza, ha az aktív munkaelem elérhető.
isDirty()	Igaz értéket ad vissza, ha az aktív munkaelem piszkos.
isNew()	Igaz értéket ad vissza, ha az aktív munkaelem új.
isValid()	Igaz értéket ad vissza, ha az aktív munkaelem mezői mind érvényesek.
refresh()	Frissíti az aktív munkaelemet. A rendszer megkérdezi a felhasználót, hogy a munkaelem piszkos-e.
removeWorkItemRelations(WorkItemRelation[])	Eltávolítja a munkaelemből egy másik munkaelemre vagy összetevőre (például véglegesítésekre, hivatkozásokra) mutató hivatkozásokat. A függvény jelenleg nem támogatja a mellékletet.
reset()	Állítsa alaphelyzetbe az aktív munkaelem módosításait. Megkéri a felhasználót, hogy erősítse meg a kérést.
save()	Menti az aktív munkaelemet.
setError(string)	Érvénytelenként jelöli meg a munkaelemet, és letiltja a munkaelem mentését az űrlapon.
setFieldValue(string, Object)	Az aktív munkaelem mezőértékének beállítása.
setFieldValues({[fieldName: string]: Object})	Az aktív munkaelem mezőértékeinek beállítása.

Metódus adatai

addWorkItemRelations(WorkItemRelation[])

Más munkaelemekre vagy összetevőkre (például véglegesítésekre, hivatkozásokra) mutató hivatkozásokat ad hozzá a munkaelemhez. A függvény jelenleg nem támogatja a mellékletet.

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

Paraméterek

workItemRelations

WorkItemRelation[]

Hozzáadandó munkaelem-hivatkozások.

Válaszok

Promise<void>

Üres ígéret.

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

@deprecated: Használja a mentést

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

Paraméterek

successCallback

() => void

errorCallback

() => void

Válaszok

Promise<void>

clearError()

Törli a setError metódus által beállított hibát, és feloldja a munkaelem mentésének letiltását az űrlapon.

function clearError(): Promise<void>

Válaszok

Promise<void>

getAllowedFieldValues(string)

Lekéri az aktív munkaelem mezőjének engedélyezett értékeit.

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

Paraméterek

fieldReferenceName

string

Mezőhivatkozás neve

Válaszok

Promise<Object[]>

Egy ígéret, amely az engedélyezett értékek tömbét adja vissza.

getDirtyFields(boolean)

Beolvashatja azokat a mezőket, amelyeket felhasználó vagy munkaelem-szabály módosított, és amelyek piszkos állapotban vannak.

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

Paraméterek

includeSystemChanges

boolean

Logikai érték, amely jelzi, hogy az eredménynek tartalmaznia kell-e a munkaelem-szabályok által beállított módosításokat.

Válaszok

Promise<WorkItemField[]>

Egy ígéret, amely piszkos munkaelemmezők tömbét adja vissza.

getFields()

Lekéri az aktív munkaelemmezőket.

function getFields(): Promise<WorkItemField[]>

Válaszok

Promise<WorkItemField[]>

Egy ígéret, amely egy munkaelem-mezőtömböt ad vissza.

getFieldValue(string, boolean)

Figyelmeztetés

Ez az API már elavult.

Please use options instead of returnOriginalValue

Lekéri az aktív munkaelem mezőértékét.

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

Paraméterek

fieldReferenceName

string

Mezőhivatkozás neve

returnOriginalValue

boolean

(Nem kötelező) Ha hamis, nem mentett mezőértékeket kap. Az alapértelmezett érték hamis.

Válaszok

Promise<Object>

Ígéret, amely a munkaelem mező értékét adja vissza.

getFieldValue(string, WorkItemOptions)

Lekéri az aktív munkaelem mezőértékét.

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

Paraméterek

fieldReferenceName

string

Mezőhivatkozás neve

options

WorkItemOptions

munkaelem beállításai

Válaszok

Promise<Object>

Ígéret, amely a munkaelem mező értékét adja vissza.

getFieldValues(string[], boolean)

Figyelmeztetés

Ez az API már elavult.

Please use options instead of returnOriginalValue

Lekéri az aktív munkaelem mezőértékét.

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

Paraméterek

fieldReferenceNames

string[]

Mezőhivatkozások neveinek összessége

returnOriginalValue

boolean

(Nem kötelező) Ha hamis, nem mentett mezőértékeket kap. Az alapértelmezett érték hamis.

Válaszok

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

Ígéret, amely visszaadja a munkaelem mezőértékeinek szótárát (refName értékpárokra).

getFieldValues(string[], WorkItemOptions)

Lekéri az aktív munkaelem mezőértékét.

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

Paraméterek

fieldReferenceNames

string[]

Mezőhivatkozások neveinek összessége

options

WorkItemOptions

munkaelem beállításai

Válaszok

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

Ígéret, amely visszaadja a munkaelem mezőértékeinek szótárát (refName értékpárokra).

getId()

Lekéri az aktív munkaelem azonosítóját.

function getId(): Promise<number>

Válaszok

Promise<number>

Ígéret, amely visszaadja az aktív munkaelem-azonosítót.

getIdentityFieldValue(string, WorkItemOptions)

Lekéri az aktív munkaelem identitásmező-értékét.

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

Paraméterek

fieldReferenceName

string

Mezőhivatkozás neve

options

WorkItemOptions

munkaelem beállításai

Válaszok

Promise<IdentityRef>

Ígéret, amely a munkaelem mező értékét adja vissza.

getInvalidFields()

Azokat a mezőket kapja meg, amelyek a munkaelem-szabályok szerint érvénytelen állapotban vannak. Ezeket a mezőket módosítani kell a munkaelem mentése előtt.

function getInvalidFields(): Promise<WorkItemField[]>

Válaszok

Promise<WorkItemField[]>

Egy ígéret, amely érvénytelen munkaelemmezők tömbét adja vissza.

getRevision()

Lekéri az aktív munkaelem legújabb változatát.

function getRevision(): Promise<number>

Válaszok

Promise<number>

Ígéret, amely visszaadja az aktív munkaelem legújabb változatazonosítóját.

getWorkItemRelations()

Munkaelem-hivatkozásokat tartalmazó tömböt ad vissza más munkaelemekhez vagy összetevőkhöz (például véglegesítésekhez, hivatkozásokhoz). A függvény jelenleg nem támogatja a mellékletet.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Válaszok

Promise<WorkItemRelation[]>

Ígéret, amely az aktív munkaelem munkaelem-kapcsolatainak tömbét adja vissza.

getWorkItemRelationTypes()

Munkaelem-relációs típusokat tartalmazó tömböt ad vissza.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Válaszok

Promise<WorkItemRelationType[]>

Ígéret, amely munkaelem-relációs típusok tömbét adja vissza.

getWorkItemResourceUrl(number)

A megadott munkaelem-erőforrás REST API-URL-címét adja vissza.

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

Paraméterek

workItemId

number

Annak a munkaelemnek az azonosítója, amelyet az erőforrás URL-címe kér.

Válaszok

Promise<string>

Ígéret, amely visszaadja a munkaelem kért erőforrás-URL-címét.

hasActiveWorkItem()

Igaz értéket ad vissza, ha az aktív munkaelem elérhető.

function hasActiveWorkItem(): Promise<boolean>

Válaszok

Promise<boolean>

A logikai értéket visszaadó ígéret jelzi, hogy az aktív munkaelem elérhető-e.

isDirty()

Igaz értéket ad vissza, ha az aktív munkaelem piszkos.

function isDirty(): Promise<boolean>

Válaszok

Promise<boolean>

A logikai értéket visszaadó ígéret jelzi, hogy az aktív munkaelem piszkos-e.

isNew()

Igaz értéket ad vissza, ha az aktív munkaelem új.

function isNew(): Promise<boolean>

Válaszok

Promise<boolean>

A logikai értéket visszaadó ígéret jelzi, hogy az aktív munkaelem új-e.

isValid()

Igaz értéket ad vissza, ha az aktív munkaelem mezői mind érvényesek.

function isValid(): Promise<boolean>

Válaszok

Promise<boolean>

A logikai értéket visszaadó ígéret jelzi, hogy az összes mezőérték érvényes-e.

refresh()

Frissíti az aktív munkaelemet. A rendszer megkérdezi a felhasználót, hogy a munkaelem piszkos-e.

function refresh(): Promise<void>

Válaszok

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Eltávolítja a munkaelemből egy másik munkaelemre vagy összetevőre (például véglegesítésekre, hivatkozásokra) mutató hivatkozásokat. A függvény jelenleg nem támogatja a mellékletet.

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

Paraméterek

workItemRelations

WorkItemRelation[]

Eltávolítandó munkaelem-hivatkozások.

Válaszok

Promise<void>

Üres ígéret.

reset()

Állítsa alaphelyzetbe az aktív munkaelem módosításait. Megkéri a felhasználót, hogy erősítse meg a kérést.

function reset(): Promise<void>

Válaszok

Promise<void>

save()

Menti az aktív munkaelemet.

function save(): Promise<void>

Válaszok

Promise<void>

A munkaelem sikeres mentése és elutasítása esetén feloldott ígéret.

setError(string)

Érvénytelenként jelöli meg a munkaelemet, és letiltja a munkaelem mentését az űrlapon.

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

Paraméterek

errorMessage

string

Egyéni hibaüzenet, amely a munkaelem-űrlap tetején jelenik meg.

Válaszok

Promise<void>

setFieldValue(string, Object)

Az aktív munkaelem mezőértékének beállítása.

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

Paraméterek

fieldReferenceName

string

Mezőhivatkozás neve

value

Object

Mezőérték

Válaszok

Promise<boolean>

A logikai értéket visszaadó ígéret jelzi, hogy a függvény sikeresen befejeződött-e.

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

Az aktív munkaelem mezőértékeinek beállítása.

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

Paraméterek

fields

{[fieldName: string]: Object}

A mező refName/values szótára

Válaszok

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

Ígéret, amely visszaadja a mezőértékek frissítési eredményeinek szótárát (az eredménypárok refName-ját).