IWorkItemFormService interface
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. Verrà generato un errore quando non è presente alcun elemento di lavoro aperto.
Metodi
| add |
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. |
| begin |
@deprecated: Si prega di utilizzare save |
| clear |
Cancella il set di errori impostando il metodoError e sblocca il salvataggio dell'elemento di lavoro nel modulo. |
| get |
Ottiene i valori consentiti per il campo nell'elemento di lavoro attivo. |
| get |
Ottiene i campi modificati dall'utente o da una regola dell'elemento di lavoro e si trovano in uno stato dirty. |
| get |
Ottiene i campi dell'elemento di lavoro attivi. |
| get |
Ottiene il valore del campo dell'elemento di lavoro attivo. |
| get |
Ottiene il valore del campo dell'elemento di lavoro attivo. |
| get |
Ottiene i valori di campo dell'elemento di lavoro attivo. |
| get |
Ottiene i valori di campo dell'elemento di lavoro attivo. |
| get |
Ottiene l'ID dell'elemento di lavoro attivo. |
| get |
Ottiene il valore del campo Identity dell'elemento di lavoro attivo. |
| get |
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 l'elemento di lavoro possa essere salvato. |
| get |
Ottiene la revisione più recente dell'elemento di lavoro attivo. |
| get |
Restituisce una matrice di collegamenti di elementi di lavoro ad altri elementi di lavoro o artefatti( ad esempio commit, collegamenti ipertestuali). L'allegato non è attualmente supportato da questa funzione. |
| get |
Restituisce una matrice di tipi di relazione tra elementi di lavoro. |
| get |
Restituisce l'URL dell'API REST della risorsa dell'elemento di lavoro specificato. |
| has |
Restituisce true se l'elemento di lavoro attivo è disponibile. |
| is |
Restituisce true se l'elemento di lavoro attivo è dirty. |
| is |
Restituisce true se l'elemento di lavoro attivo è nuovo. |
| is |
Restituisce true se i campi dell'elemento di lavoro attivo sono tutti validi. |
| refresh() | Aggiorna l'elemento di lavoro attivo. Chiederà all'utente se l'elemento di lavoro è dirty. |
| remove |
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. |
| set |
Contrassegna l'elemento di lavoro come non valido e disabilita il salvataggio dell'elemento di lavoro nel modulo. |
| set |
Imposta il valore del campo dell'elemento di lavoro attivo. |
| set |
Imposta i valori dei campi 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
Collegamenti all'elemento di lavoro da aggiungere.
Valori restituiti
Promise<void>
Una promessa vuota.
beginSaveWorkItem(() => void, () => void)
@deprecated: Si prega di utilizzare save
function beginSaveWorkItem(successCallback: () => void, errorCallback: () => void): Promise<void>
Parametri
- successCallback
-
() => void
- errorCallback
-
() => void
Valori restituiti
Promise<void>
clearError()
Cancella il set di errori impostando il metodoError e sblocca il salvataggio dell'elemento di lavoro nel modulo.
function clearError(): Promise<void>
Valori restituiti
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
Valori restituiti
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.
Valori restituiti
Promise<WorkItemField[]>
Promessa che restituisce una matrice di campi dell'elemento di lavoro dirty.
getFields()
Ottiene i campi dell'elemento di lavoro attivi.
function getFields(): Promise<WorkItemField[]>
Valori restituiti
Promise<WorkItemField[]>
Promessa che restituisce una matrice di campi 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. Il valore predefinito è false.
Valori restituiti
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
Valori restituiti
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[]
Un oggetto arrary dei nomi di riferimento dei campi
- returnOriginalValue
-
boolean
(Facoltativo) Se false, ottiene i valori dei campi non salvati. Il valore predefinito è false.
Valori restituiti
Promise<{[fieldName: string]: Object}>
Promessa che restituisce un dizionario di valori dei campi 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[]
Un oggetto arrary dei nomi di riferimento dei campi
- options
- WorkItemOptions
opzioni dell'elemento di lavoro
Valori restituiti
Promise<{[fieldName: string]: Object}>
Promessa che restituisce un dizionario di valori dei campi dell'elemento di lavoro (refName alle coppie di valori).
getId()
Ottiene l'ID dell'elemento di lavoro attivo.
function getId(): Promise<number>
Valori restituiti
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
Valori restituiti
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 l'elemento di lavoro possa essere salvato.
function getInvalidFields(): Promise<WorkItemField[]>
Valori restituiti
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>
Valori restituiti
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 artefatti( ad esempio commit, collegamenti ipertestuali). L'allegato non è attualmente supportato da questa funzione.
function getWorkItemRelations(): Promise<WorkItemRelation[]>
Valori restituiti
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[]>
Valori restituiti
Promise<WorkItemRelationType[]>
Promessa che restituisce una matrice di tipi di relazione elemento 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.
Valori restituiti
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>
Valori restituiti
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>
Valori restituiti
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>
Valori restituiti
Promise<boolean>
Una promessa che restituisce un valore booleano indica se l'elemento di lavoro attivo è nuovo.
isValid()
Restituisce true se i campi dell'elemento di lavoro attivo sono tutti validi.
function isValid(): Promise<boolean>
Valori restituiti
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. Chiederà all'utente se l'elemento di lavoro è dirty.
function refresh(): Promise<void>
Valori restituiti
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
Collegamenti agli elementi di lavoro da rimuovere.
Valori restituiti
Promise<void>
Una promessa vuota.
reset()
Reimpostare le modifiche apportate all'elemento di lavoro attivo. Chiederà all'utente di confermare.
function reset(): Promise<void>
Valori restituiti
Promise<void>
save()
Salva l'elemento di lavoro attivo.
function save(): Promise<void>
Valori restituiti
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 verrebbe visualizzato sopra il modulo dell'elemento di lavoro.
Valori restituiti
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
Valori restituiti
Promise<boolean>
Una promessa che restituisce un valore booleano indica se la funzione è stata completata correttamente.
setFieldValues({[fieldName: string]: Object})
Imposta i valori dei campi 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
Valori restituiti
Promise<{[fieldName: string]: boolean}>
Promessa che restituisce un dizionario dei risultati dell'aggiornamento dei valori di campo (refName alle coppie di risultati).