IWorkItemFormService interface

Paquete:

azure-devops-extension-api

Servicio de host para interactuar con el formulario de elemento de trabajo activo actualmente (elemento de trabajo que se muestra actualmente en la interfaz de usuario). El servicio formulario depende del contexto actual del elemento de trabajo activo. Producirá un error cuando no haya ningún elemento de trabajo abierto.

Métodos

addWorkItemRelations(WorkItemRelation[])	Agrega vínculos de otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos) al elemento de trabajo. Actualmente, esta función no admite datos adjuntos.
beginSaveWorkItem(() => void, () => void)	@deprecated: use save
clearError()	Borra el error establecido por el método setError y desbloquea el guardado del elemento de trabajo en el formulario.
getAllowedFieldValues(string)	Obtiene los valores permitidos para el campo en el elemento de trabajo activo.
getDirtyFields(boolean)	Obtiene los campos modificados por el usuario o por una regla de elemento de trabajo y que están en un estado desfasado.
getFields()	Obtiene los campos de elementos de trabajo activos.
getFieldValue(string, boolean)	Obtiene el valor de campo del elemento de trabajo activo.
getFieldValue(string, WorkItemOptions)	Obtiene el valor de campo del elemento de trabajo activo.
getFieldValues(string[], boolean)	Obtiene los valores de campo del elemento de trabajo activo.
getFieldValues(string[], WorkItemOptions)	Obtiene los valores de campo del elemento de trabajo activo.
getId()	Obtiene el identificador del elemento de trabajo activo.
getIdentityFieldValue(string, WorkItemOptions)	Obtiene el valor del campo de identidad del elemento de trabajo activo.
getInvalidFields()	Obtiene los campos que están en un estado no válido según las reglas del elemento de trabajo. Estos campos deben cambiarse antes de que se pueda guardar el elemento de trabajo.
getRevision()	Obtiene la revisión más reciente del elemento de trabajo activo.
getWorkItemRelations()	Devuelve una matriz de vínculos de elementos de trabajo a otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos). Actualmente, esta función no admite datos adjuntos.
getWorkItemRelationTypes()	Devuelve una matriz de tipos de relación de elementos de trabajo.
getWorkItemResourceUrl(number)	Devuelve la dirección URL de la API rest del recurso de elemento de trabajo especificado.
hasActiveWorkItem()	Devuelve true si el elemento de trabajo activo está disponible.
isDirty()	Devuelve true si el elemento de trabajo activo está sucio.
isNew()	Devuelve true si el elemento de trabajo activo es nuevo.
isValid()	Devuelve true si los campos del elemento de trabajo activo son válidos.
refresh()	Actualiza el elemento de trabajo activo. Solicitará al usuario si el elemento de trabajo está sucio.
removeWorkItemRelations(WorkItemRelation[])	Quita vínculos a otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos) del elemento de trabajo. Actualmente, esta función no admite datos adjuntos.
reset()	Restablezca los cambios en el elemento de trabajo activo. Solicitará al usuario que confirme.
save()	Guarda el elemento de trabajo activo.
setError(string)	Marca el elemento de trabajo como no válido y deshabilita guardar el elemento de trabajo en el formulario.
setFieldValue(string, Object)	Establece el valor de campo del elemento de trabajo activo.
setFieldValues({[fieldName: string]: Object})	Establece los valores de campo del elemento de trabajo activo.

Detalles del método

addWorkItemRelations(WorkItemRelation[])

Agrega vínculos de otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos) al elemento de trabajo. Actualmente, esta función no admite datos adjuntos.

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

Parámetros

workItemRelations

WorkItemRelation[]

Vínculos de elemento de trabajo que se van a agregar.

Devoluciones

Promise<void>

Una promesa vacía.

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

@deprecated: use save

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

Parámetros

successCallback

() => void

errorCallback

() => void

Devoluciones

Promise<void>

clearError()

Borra el error establecido por el método setError y desbloquea el guardado del elemento de trabajo en el formulario.

function clearError(): Promise<void>

Devoluciones

Promise<void>

getAllowedFieldValues(string)

Obtiene los valores permitidos para el campo en el elemento de trabajo activo.

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

Parámetros

fieldReferenceName

string

Nombre de referencia de campo

Devoluciones

Promise<Object[]>

Promesa que devuelve una matriz de valores permitidos.

getDirtyFields(boolean)

Obtiene los campos modificados por el usuario o por una regla de elemento de trabajo y que están en un estado desfasado.

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

Parámetros

includeSystemChanges

boolean

Valor booleano que indica si el resultado debe incluir cambios establecidos por reglas de elementos de trabajo.

Devoluciones

Promise<WorkItemField[]>

Promesa que devuelve una matriz de campos de elementos de trabajo sucios.

getFields()

Obtiene los campos de elementos de trabajo activos.

function getFields(): Promise<WorkItemField[]>

Devoluciones

Promise<WorkItemField[]>

Promesa que devuelve una matriz de campos de elemento de trabajo.

getFieldValue(string, boolean)

Advertencia

Esta API ya está en desuso.

Please use options instead of returnOriginalValue

Obtiene el valor de campo del elemento de trabajo activo.

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

Parámetros

fieldReferenceName

string

Nombre de referencia de campo

returnOriginalValue

boolean

(Opcional) Si es false, obtiene valores de campo no guardados. El valor predeterminado es False.

Devoluciones

Promise<Object>

Promesa que devuelve el valor del campo de elemento de trabajo.

getFieldValue(string, WorkItemOptions)

Obtiene el valor de campo del elemento de trabajo activo.

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

Parámetros

fieldReferenceName

string

Nombre de referencia de campo

options

WorkItemOptions

opciones de elemento de trabajo

Devoluciones

Promise<Object>

Promesa que devuelve el valor del campo de elemento de trabajo.

getFieldValues(string[], boolean)

Advertencia

Esta API ya está en desuso.

Please use options instead of returnOriginalValue

Obtiene los valores de campo del elemento de trabajo activo.

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

Parámetros

fieldReferenceNames

string[]

Una arrary de nombres de referencia de campo

returnOriginalValue

boolean

(Opcional) Si es false, obtiene valores de campo no guardados. El valor predeterminado es False.

Devoluciones

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

Promesa que devuelve un diccionario de valores de campo de elemento de trabajo (refName a pares de valores).

getFieldValues(string[], WorkItemOptions)

Obtiene los valores de campo del elemento de trabajo activo.

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

Parámetros

fieldReferenceNames

string[]

Una arrary de nombres de referencia de campo

options

WorkItemOptions

opciones de elemento de trabajo

Devoluciones

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

Promesa que devuelve un diccionario de valores de campo de elemento de trabajo (refName a pares de valores).

getId()

Obtiene el identificador del elemento de trabajo activo.

function getId(): Promise<number>

Devoluciones

Promise<number>

Promesa que devuelve el identificador de elemento de trabajo activo.

getIdentityFieldValue(string, WorkItemOptions)

Obtiene el valor del campo de identidad del elemento de trabajo activo.

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

Parámetros

fieldReferenceName

string

Nombre de referencia de campo

options

WorkItemOptions

opciones de elemento de trabajo

Devoluciones

Promise<IdentityRef>

Promesa que devuelve el valor del campo de elemento de trabajo.

getInvalidFields()

Obtiene los campos que están en un estado no válido según las reglas del elemento de trabajo. Estos campos deben cambiarse antes de que se pueda guardar el elemento de trabajo.

function getInvalidFields(): Promise<WorkItemField[]>

Devoluciones

Promise<WorkItemField[]>

Promesa que devuelve una matriz de campos de elementos de trabajo no válidos.

getRevision()

Obtiene la revisión más reciente del elemento de trabajo activo.

function getRevision(): Promise<number>

Devoluciones

Promise<number>

Promesa que devuelve el identificador de revisión más reciente del elemento de trabajo activo.

getWorkItemRelations()

Devuelve una matriz de vínculos de elementos de trabajo a otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos). Actualmente, esta función no admite datos adjuntos.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Devoluciones

Promise<WorkItemRelation[]>

Promesa que devuelve una matriz de relaciones de elementos de trabajo del elemento de trabajo activo.

getWorkItemRelationTypes()

Devuelve una matriz de tipos de relación de elementos de trabajo.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Devoluciones

Promise<WorkItemRelationType[]>

Promesa que devuelve una matriz de tipos de relación de elementos de trabajo.

getWorkItemResourceUrl(number)

Devuelve la dirección URL de la API rest del recurso de elemento de trabajo especificado.

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

Parámetros

workItemId

number

Identificador del elemento de trabajo para el que se solicita la dirección URL del recurso.

Devoluciones

Promise<string>

Promesa que devuelve la dirección URL de recurso solicitada del elemento de trabajo.

hasActiveWorkItem()

Devuelve true si el elemento de trabajo activo está disponible.

function hasActiveWorkItem(): Promise<boolean>

Devoluciones

Promise<boolean>

Una promesa que devuelve un valor booleano indica si el elemento de trabajo activo está disponible.

isDirty()

Devuelve true si el elemento de trabajo activo está sucio.

function isDirty(): Promise<boolean>

Devoluciones

Promise<boolean>

Una promesa que devuelve un valor booleano indica si el elemento de trabajo activo está sucio.

isNew()

Devuelve true si el elemento de trabajo activo es nuevo.

function isNew(): Promise<boolean>

Devoluciones

Promise<boolean>

Una promesa que devuelve un valor booleano indica si el elemento de trabajo activo es nuevo.

isValid()

Devuelve true si los campos del elemento de trabajo activo son válidos.

function isValid(): Promise<boolean>

Devoluciones

Promise<boolean>

Una promesa que devuelve un valor booleano indica si todos los valores de campo son válidos.

refresh()

Actualiza el elemento de trabajo activo. Solicitará al usuario si el elemento de trabajo está sucio.

function refresh(): Promise<void>

Devoluciones

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Quita vínculos a otros elementos de trabajo o artefactos (por ejemplo, confirmaciones, hipervínculos) del elemento de trabajo. Actualmente, esta función no admite datos adjuntos.

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

Parámetros

workItemRelations

WorkItemRelation[]

Vínculos de elemento de trabajo que se van a quitar.

Devoluciones

Promise<void>

Una promesa vacía.

reset()

Restablezca los cambios en el elemento de trabajo activo. Solicitará al usuario que confirme.

function reset(): Promise<void>

Devoluciones

Promise<void>

save()

Guarda el elemento de trabajo activo.

function save(): Promise<void>

Devoluciones

Promise<void>

Promesa que se resuelve si el elemento de trabajo se guarda correctamente y se rechaza si se produce un error.

setError(string)

Marca el elemento de trabajo como no válido y deshabilita guardar el elemento de trabajo en el formulario.

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

Parámetros

errorMessage

string

Mensaje de error personalizado que se mostraría encima del formulario de elemento de trabajo.

Devoluciones

Promise<void>

setFieldValue(string, Object)

Establece el valor de campo del elemento de trabajo activo.

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

Parámetros

fieldReferenceName

string

Nombre de referencia de campo

value

Object

Valor de campo

Devoluciones

Promise<boolean>

Una promesa que devuelve un valor booleano indica si la función se completó correctamente.

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

Establece los valores de campo del elemento de trabajo activo.

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

Parámetros

fields

{[fieldName: string]: Object}

Diccionario de valores/refName de campo

Devoluciones

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

Promesa que devuelve un diccionario de resultados de actualización de valores de campo (refName a pares de resultados).