IWorkItemFormService interface

Pacchetto:

azure-devops-extension-api

Servizio host per l'interazione con il modulo dell'elemento di lavoro attualmente attivo (elemento di lavoro attualmente visualizzato nell'interfaccia utente). Il servizio modulo dipende dal contesto dell'elemento di lavoro attivo corrente. Genererà un errore quando non è presente alcun elemento di lavoro aperto.

Metodi

addWorkItemRelations(WorkItemRelation[])	Aggiunge collegamenti di altri elementi di lavoro o artefatti (ad esempio commit, collegamenti ipertestuali) all'elemento di lavoro. L'allegato non è attualmente supportato da questa funzione.
beginSaveWorkItem(() => void, () => void)	@deprecated: usare salva
clearError()	Cancella l'errore impostato dal metodo setError e sblocca il salvataggio dell'elemento di lavoro nel modulo.
getAllowedFieldValues(string)	Ottiene i valori consentiti per il campo nell'elemento di lavoro attivo.
getDirtyFields(boolean)	Ottiene i campi modificati dall'utente o da una regola dell'elemento di lavoro e si trovano in uno stato dirty.
getFields()	Ottiene i campi degli elementi di lavoro attivi.
getFieldValue(string, boolean)	Ottiene il valore del campo dell'elemento di lavoro attivo.
getFieldValue(string, WorkItemOptions)	Ottiene il valore del campo dell'elemento di lavoro attivo.
getFieldValues(string[], boolean)	Ottiene i valori di campo dell'elemento di lavoro attivo.
getFieldValues(string[], WorkItemOptions)	Ottiene i valori di campo dell'elemento di lavoro attivo.
getId()	Ottiene l'ID dell'elemento di lavoro attivo.
getIdentityFieldValue(string, WorkItemOptions)	Ottiene il valore del campo Identity dell'elemento di lavoro attivo.
getInvalidFields()	Ottiene i campi che si trovano in uno stato non valido in base alle regole dell'elemento di lavoro. Questi campi devono essere modificati prima che sia possibile salvare l'elemento di lavoro.
getRevision()	Ottiene la revisione più recente dell'elemento di lavoro attivo.
getWorkItemRelations()	Restituisce una matrice di collegamenti di elementi di lavoro ad altri elementi di lavoro o elementi (ad esempio commit, collegamenti ipertestuali). L'allegato non è attualmente supportato da questa funzione.
getWorkItemRelationTypes()	Restituisce una matrice di tipi di relazione tra elementi di lavoro.
getWorkItemResourceUrl(number)	Restituisce l'URL dell'API REST della risorsa dell'elemento di lavoro specificato.
hasActiveWorkItem()	Restituisce true se l'elemento di lavoro attivo è disponibile.
isDirty()	Restituisce true se l'elemento di lavoro attivo è dirty.
isNew()	Restituisce true se l'elemento di lavoro attivo è nuovo.
isValid()	Restituisce true se i campi degli elementi di lavoro attivi sono tutti validi.
refresh()	Aggiorna l'elemento di lavoro attivo. Richiederà all'utente se l'elemento di lavoro è dirty.
removeWorkItemRelations(WorkItemRelation[])	Rimuove i collegamenti a un altro elemento di lavoro o artefatti (ad esempio commit, collegamenti ipertestuali) dall'elemento di lavoro. L'allegato non è attualmente supportato da questa funzione.
reset()	Reimpostare le modifiche apportate all'elemento di lavoro attivo. Chiederà all'utente di confermare.
save()	Salva l'elemento di lavoro attivo.
setError(string)	Contrassegna l'elemento di lavoro come non valido e disabilita il salvataggio dell'elemento di lavoro nel modulo.
setFieldValue(string, Object)	Imposta il valore del campo dell'elemento di lavoro attivo.
setFieldValues({[fieldName: string]: Object})	Imposta i valori di campo dell'elemento di lavoro attivo.

Dettagli metodo

addWorkItemRelations(WorkItemRelation[])

Aggiunge collegamenti di altri elementi di lavoro o artefatti (ad esempio commit, collegamenti ipertestuali) all'elemento di lavoro. L'allegato non è attualmente supportato da questa funzione.

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

Parametri

workItemRelations

WorkItemRelation[]

Collegamenti agli elementi di lavoro da aggiungere.

Restituisce

Promise<void>

Una promessa vuota.

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

@deprecated: usare salva

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

Parametri

successCallback

() => void

errorCallback

() => void

Restituisce

Promise<void>

clearError()

Cancella l'errore impostato dal metodo setError e sblocca il salvataggio dell'elemento di lavoro nel modulo.

function clearError(): Promise<void>

Restituisce

Promise<void>

getAllowedFieldValues(string)

Ottiene i valori consentiti per il campo nell'elemento di lavoro attivo.

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

Parametri

fieldReferenceName

string

Nome riferimento campo

Restituisce

Promise<Object[]>

Promessa che restituisce una matrice di valori consentiti.

getDirtyFields(boolean)

Ottiene i campi modificati dall'utente o da una regola dell'elemento di lavoro e si trovano in uno stato dirty.

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

Parametri

includeSystemChanges

boolean

Valore booleano che indica se il risultato deve includere modifiche impostate dalle regole dell'elemento di lavoro.

Restituisce

Promise<WorkItemField[]>

Promessa che restituisce una matrice di campi dell'elemento di lavoro dirty.

getFields()

Ottiene i campi degli elementi di lavoro attivi.

function getFields(): Promise<WorkItemField[]>

Restituisce

Promise<WorkItemField[]>

Promessa che restituisce una matrice di campo dell'elemento di lavoro.

getFieldValue(string, boolean)

Avviso

Questa API è ora deprecata.

Please use options instead of returnOriginalValue

Ottiene il valore del campo dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceName

string

Nome riferimento campo

returnOriginalValue

boolean

(Facoltativo) Se false, ottiene i valori dei campi non salvati. L'impostazione predefinita è false.

Restituisce

Promise<Object>

Promessa che restituisce il valore del campo dell'elemento di lavoro.

getFieldValue(string, WorkItemOptions)

Ottiene il valore del campo dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceName

string

Nome riferimento campo

options

WorkItemOptions

opzioni dell'elemento di lavoro

Restituisce

Promise<Object>

Promessa che restituisce il valore del campo dell'elemento di lavoro.

getFieldValues(string[], boolean)

Avviso

Questa API è ora deprecata.

Please use options instead of returnOriginalValue

Ottiene i valori di campo dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceNames

string[]

Arrary dei nomi dei riferimenti di campo

returnOriginalValue

boolean

(Facoltativo) Se false, ottiene i valori dei campi non salvati. L'impostazione predefinita è false.

Restituisce

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

Promessa che restituisce un dizionario di valori di campo dell'elemento di lavoro (refName alle coppie di valori).

getFieldValues(string[], WorkItemOptions)

Ottiene i valori di campo dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceNames

string[]

Arrary dei nomi dei riferimenti di campo

options

WorkItemOptions

opzioni dell'elemento di lavoro

Restituisce

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

Promessa che restituisce un dizionario di valori di campo dell'elemento di lavoro (refName alle coppie di valori).

getId()

Ottiene l'ID dell'elemento di lavoro attivo.

function getId(): Promise<number>

Restituisce

Promise<number>

Promessa che restituisce l'ID elemento di lavoro attivo.

getIdentityFieldValue(string, WorkItemOptions)

Ottiene il valore del campo Identity dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceName

string

Nome riferimento campo

options

WorkItemOptions

opzioni dell'elemento di lavoro

Restituisce

Promise<IdentityRef>

Promessa che restituisce il valore del campo dell'elemento di lavoro.

getInvalidFields()

Ottiene i campi che si trovano in uno stato non valido in base alle regole dell'elemento di lavoro. Questi campi devono essere modificati prima che sia possibile salvare l'elemento di lavoro.

function getInvalidFields(): Promise<WorkItemField[]>

Restituisce

Promise<WorkItemField[]>

Promessa che restituisce una matrice di campi dell'elemento di lavoro non validi.

getRevision()

Ottiene la revisione più recente dell'elemento di lavoro attivo.

function getRevision(): Promise<number>

Restituisce

Promise<number>

Promessa che restituisce l'ID revisione più recente dell'elemento di lavoro attivo.

getWorkItemRelations()

Restituisce una matrice di collegamenti di elementi di lavoro ad altri elementi di lavoro o elementi (ad esempio commit, collegamenti ipertestuali). L'allegato non è attualmente supportato da questa funzione.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Restituisce

Promise<WorkItemRelation[]>

Promessa che restituisce una matrice di relazioni tra elementi di lavoro dell'elemento di lavoro attivo.

getWorkItemRelationTypes()

Restituisce una matrice di tipi di relazione tra elementi di lavoro.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Restituisce

Promise<WorkItemRelationType[]>

Promessa che restituisce una matrice di tipi di relazione tra elementi di lavoro.

getWorkItemResourceUrl(number)

Restituisce l'URL dell'API REST della risorsa dell'elemento di lavoro specificato.

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

Parametri

workItemId

number

ID dell'elemento di lavoro per cui è richiesto l'URL della risorsa.

Restituisce

Promise<string>

Promessa che restituisce l'URL della risorsa richiesta dell'elemento di lavoro.

hasActiveWorkItem()

Restituisce true se l'elemento di lavoro attivo è disponibile.

function hasActiveWorkItem(): Promise<boolean>

Restituisce

Promise<boolean>

Una promessa che restituisce un valore booleano indica se l'elemento di lavoro attivo è disponibile.

isDirty()

Restituisce true se l'elemento di lavoro attivo è dirty.

function isDirty(): Promise<boolean>

Restituisce

Promise<boolean>

Una promessa che restituisce un valore booleano indica se l'elemento di lavoro attivo è dirty.

isNew()

Restituisce true se l'elemento di lavoro attivo è nuovo.

function isNew(): Promise<boolean>

Restituisce

Promise<boolean>

Una promessa che restituisce un valore booleano indica se l'elemento di lavoro attivo è nuovo.

isValid()

Restituisce true se i campi degli elementi di lavoro attivi sono tutti validi.

function isValid(): Promise<boolean>

Restituisce

Promise<boolean>

Una promessa che restituisce un valore booleano indica se tutti i valori di campo sono validi.

refresh()

Aggiorna l'elemento di lavoro attivo. Richiederà all'utente se l'elemento di lavoro è dirty.

function refresh(): Promise<void>

Restituisce

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Rimuove i collegamenti a un altro elemento di lavoro o artefatti (ad esempio commit, collegamenti ipertestuali) dall'elemento di lavoro. L'allegato non è attualmente supportato da questa funzione.

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

Parametri

workItemRelations

WorkItemRelation[]

Collegamenti agli elementi di lavoro da rimuovere.

Restituisce

Promise<void>

Una promessa vuota.

reset()

Reimpostare le modifiche apportate all'elemento di lavoro attivo. Chiederà all'utente di confermare.

function reset(): Promise<void>

Restituisce

Promise<void>

save()

Salva l'elemento di lavoro attivo.

function save(): Promise<void>

Restituisce

Promise<void>

Promessa risolta se l'elemento di lavoro viene salvato correttamente e rifiutato in caso di errore.

setError(string)

Contrassegna l'elemento di lavoro come non valido e disabilita il salvataggio dell'elemento di lavoro nel modulo.

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

Parametri

errorMessage

string

Messaggio di errore personalizzato che verrà visualizzato sopra il modulo dell'elemento di lavoro.

Restituisce

Promise<void>

setFieldValue(string, Object)

Imposta il valore del campo dell'elemento di lavoro attivo.

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

Parametri

fieldReferenceName

string

Nome riferimento campo

value

Object

Valore campo

Restituisce

Promise<boolean>

Una promessa che restituisce un valore booleano indica se la funzione è stata completata correttamente.

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

Imposta i valori di campo dell'elemento di lavoro attivo.

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

Parametri

fields

{[fieldName: string]: Object}

Dizionario di campi refName/values

Restituisce

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

Promessa che restituisce un dizionario dei risultati dell'aggiornamento dei valori del campo (refName alle coppie di risultati).