IWorkItemFormService interface

Pacote:

azure-devops-extension-api

Serviço de anfitrião para interagir com o formulário de item de trabalho atualmente ativo (item de trabalho atualmente apresentado na IU). O serviço de formulário depende do contexto atual do item de trabalho ativo. Gerará um erro quando não existir nenhum item de trabalho aberto.

Métodos

addWorkItemRelations(WorkItemRelation[])	Adiciona ligações de outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações) ao item de trabalho. Atualmente, o anexo não é suportado por esta função.
beginSaveWorkItem(() => void, () => void)	@deprecated: utilize guardar
clearError()	Limpa o erro definido pelo método setError e desbloqueia a gravação do item de trabalho no formulário.
getAllowedFieldValues(string)	Obtém os valores permitidos para o campo no item de trabalho ativo.
getDirtyFields(boolean)	Obtém campos que foram alterados pelo utilizador ou por uma regra de item de trabalho e que estão num estado desativado.
getFields()	Obtém campos de itens de trabalho ativos.
getFieldValue(string, boolean)	Obtém o valor do campo do item de trabalho ativo.
getFieldValue(string, WorkItemOptions)	Obtém o valor do campo do item de trabalho ativo.
getFieldValues(string[], boolean)	Obtém valores de campo do item de trabalho ativo.
getFieldValues(string[], WorkItemOptions)	Obtém valores de campo do item de trabalho ativo.
getId()	Obtém o ID do item de trabalho ativo.
getIdentityFieldValue(string, WorkItemOptions)	Obtém o valor do campo de identidade do item de trabalho ativo.
getInvalidFields()	Obtém campos que estão num estado inválido de acordo com as regras do item de trabalho. Estes campos têm de ser alterados antes de o item de trabalho poder ser guardado.
getRevision()	Obtém a revisão mais recente do item de trabalho ativo.
getWorkItemRelations()	Devolve uma matriz de ligações de itens de trabalho para outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações). Atualmente, o anexo não é suportado por esta função.
getWorkItemRelationTypes()	Devolve uma matriz de tipos de relação de itens de trabalho.
getWorkItemResourceUrl(number)	Devolve o URL da API REST do recurso de item de trabalho especificado.
hasActiveWorkItem()	Devolve true se o item de trabalho ativo estiver disponível.
isDirty()	Devolve true se o item de trabalho ativo estiver sujo.
isNew()	Devolve true se o item de trabalho ativo for novo.
isValid()	Devolve true se os campos de itens de trabalho ativos forem todos válidos.
refresh()	Atualiza o item de trabalho ativo. Irá perguntar ao utilizador se o item de trabalho está sujo.
removeWorkItemRelations(WorkItemRelation[])	Remove ligações para outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações) do item de trabalho. Atualmente, o anexo não é suportado por esta função.
reset()	Reponha quaisquer alterações no item de trabalho ativo. Irá pedir ao utilizador para confirmar.
save()	Guarda o item de trabalho ativo.
setError(string)	Marca o item de trabalho como inválido e desativa a gravação do item de trabalho no formulário.
setFieldValue(string, Object)	Define o valor do campo do item de trabalho ativo.
setFieldValues({[fieldName: string]: Object})	Define valores de campo do item de trabalho ativo.

Detalhes de Método

addWorkItemRelations(WorkItemRelation[])

Adiciona ligações de outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações) ao item de trabalho. Atualmente, o anexo não é suportado por esta função.

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

Parâmetros

workItemRelations

WorkItemRelation[]

Ligações de itens de trabalho a adicionar.

Devoluções

Promise<void>

Uma promessa vazia.

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

@deprecated: utilize guardar

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

Parâmetros

successCallback

() => void

errorCallback

() => void

Devoluções

Promise<void>

clearError()

Limpa o erro definido pelo método setError e desbloqueia a gravação do item de trabalho no formulário.

function clearError(): Promise<void>

Devoluções

Promise<void>

getAllowedFieldValues(string)

Obtém os valores permitidos para o campo no item de trabalho ativo.

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

Parâmetros

fieldReferenceName

string

Nome da referência de campo

Devoluções

Promise<Object[]>

Uma promessa que devolve uma matriz de valores permitidos.

getDirtyFields(boolean)

Obtém campos que foram alterados pelo utilizador ou por uma regra de item de trabalho e que estão num estado desativado.

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

Parâmetros

includeSystemChanges

boolean

Um valor booleano que indica se o resultado deve incluir alterações definidas pelas regras do item de trabalho.

Devoluções

Promise<WorkItemField[]>

Uma promessa que devolve uma matriz de campos de itens de trabalho sujos.

getFields()

Obtém campos de itens de trabalho ativos.

function getFields(): Promise<WorkItemField[]>

Devoluções

Promise<WorkItemField[]>

Uma promessa que devolve uma matriz de campo de item de trabalho.

getFieldValue(string, boolean)

Aviso

Esta API foi preterida.

Please use options instead of returnOriginalValue

Obtém o valor do campo do item de trabalho ativo.

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

Parâmetros

fieldReferenceName

string

Nome da referência de campo

returnOriginalValue

boolean

(Opcional) Se for falso, obtém valores de campo não guardados. A predefinição é falso.

Devoluções

Promise<Object>

Uma promessa que devolve o valor do campo do item de trabalho.

getFieldValue(string, WorkItemOptions)

Obtém o valor do campo do item de trabalho ativo.

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

Parâmetros

fieldReferenceName

string

Nome da referência de campo

options

WorkItemOptions

opções de itens de trabalho

Devoluções

Promise<Object>

Uma promessa que devolve o valor do campo do item de trabalho.

getFieldValues(string[], boolean)

Aviso

Esta API foi preterida.

Please use options instead of returnOriginalValue

Obtém valores de campo do item de trabalho ativo.

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

Parâmetros

fieldReferenceNames

string[]

Uma série de nomes de referência de campos

returnOriginalValue

boolean

(Opcional) Se for falso, obtém valores de campo não guardados. A predefinição é falso.

Devoluções

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

Uma promessa que devolve um dicionário de valores de campos de itens de trabalho (refName para pares de valores).

getFieldValues(string[], WorkItemOptions)

Obtém valores de campo do item de trabalho ativo.

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

Parâmetros

fieldReferenceNames

string[]

Uma série de nomes de referência de campos

options

WorkItemOptions

opções de itens de trabalho

Devoluções

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

Uma promessa que devolve um dicionário de valores de campos de itens de trabalho (refName para pares de valores).

getId()

Obtém o ID do item de trabalho ativo.

function getId(): Promise<number>

Devoluções

Promise<number>

Uma promessa que devolve o ID do item de trabalho ativo.

getIdentityFieldValue(string, WorkItemOptions)

Obtém o valor do campo de identidade do item de trabalho ativo.

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

Parâmetros

fieldReferenceName

string

Nome da referência de campo

options

WorkItemOptions

opções de itens de trabalho

Devoluções

Promise<IdentityRef>

Uma promessa que devolve o valor do campo do item de trabalho.

getInvalidFields()

Obtém campos que estão num estado inválido de acordo com as regras do item de trabalho. Estes campos têm de ser alterados antes de o item de trabalho poder ser guardado.

function getInvalidFields(): Promise<WorkItemField[]>

Devoluções

Promise<WorkItemField[]>

Uma promessa que devolve uma matriz de campos de itens de trabalho inválidos.

getRevision()

Obtém a revisão mais recente do item de trabalho ativo.

function getRevision(): Promise<number>

Devoluções

Promise<number>

Uma promessa que devolve o ID de revisão mais recente do item de trabalho ativo.

getWorkItemRelations()

Devolve uma matriz de ligações de itens de trabalho para outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações). Atualmente, o anexo não é suportado por esta função.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Devoluções

Promise<WorkItemRelation[]>

Uma promessa que devolve uma matriz de relações de item de trabalho do item de trabalho ativo.

getWorkItemRelationTypes()

Devolve uma matriz de tipos de relação de itens de trabalho.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Devoluções

Promise<WorkItemRelationType[]>

Uma promessa que devolve uma matriz de tipos de relação de itens de trabalho.

getWorkItemResourceUrl(number)

Devolve o URL da API REST do recurso de item de trabalho especificado.

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

Parâmetros

workItemId

number

ID do item de trabalho para o qual o URL do recurso é pedido.

Devoluções

Promise<string>

Uma promessa que devolve o URL de recurso pedido do item de trabalho.

hasActiveWorkItem()

Devolve true se o item de trabalho ativo estiver disponível.

function hasActiveWorkItem(): Promise<boolean>

Devoluções

Promise<boolean>

Uma promessa que devolve um valor booleano indica se o item de trabalho ativo está disponível.

isDirty()

Devolve true se o item de trabalho ativo estiver sujo.

function isDirty(): Promise<boolean>

Devoluções

Promise<boolean>

Uma promessa que devolve um valor booleano indica se o item de trabalho ativo está sujo.

isNew()

Devolve true se o item de trabalho ativo for novo.

function isNew(): Promise<boolean>

Devoluções

Promise<boolean>

Uma promessa que devolve um valor booleano indica se o item de trabalho ativo é novo.

isValid()

Devolve true se os campos de itens de trabalho ativos forem todos válidos.

function isValid(): Promise<boolean>

Devoluções

Promise<boolean>

Uma promessa que devolve um valor booleano indica se todos os valores de campo são válidos.

refresh()

Atualiza o item de trabalho ativo. Irá perguntar ao utilizador se o item de trabalho está sujo.

function refresh(): Promise<void>

Devoluções

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Remove ligações para outros itens de trabalho ou artefactos (por exemplo, consolidações, hiperligações) do item de trabalho. Atualmente, o anexo não é suportado por esta função.

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

Parâmetros

workItemRelations

WorkItemRelation[]

Ligações de itens de trabalho a remover.

Devoluções

Promise<void>

Uma promessa vazia.

reset()

Reponha quaisquer alterações no item de trabalho ativo. Irá pedir ao utilizador para confirmar.

function reset(): Promise<void>

Devoluções

Promise<void>

save()

Guarda o item de trabalho ativo.

function save(): Promise<void>

Devoluções

Promise<void>

Uma promessa que é resolvida se o item de trabalho for guardado com êxito e rejeitado se falhar.

setError(string)

Marca o item de trabalho como inválido e desativa a gravação do item de trabalho no formulário.

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

Parâmetros

errorMessage

string

Uma mensagem de erro personalizada que seria apresentada sobre o formulário do item de trabalho.

Devoluções

Promise<void>

setFieldValue(string, Object)

Define o valor do campo do item de trabalho ativo.

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

Parâmetros

fieldReferenceName

string

Nome da referência de campo

value

Object

Valor do campo

Devoluções

Promise<boolean>

Uma promessa que devolve um valor booleano indica se a função foi concluída com êxito.

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

Define valores de campo do item de trabalho ativo.

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

Parâmetros

fields

{[fieldName: string]: Object}

Um dicionário de refName/valores de campo

Devoluções

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

Uma promessa que devolve um dicionário de resultados de atualização do valor do campo (refName para pares de resultados).