IWorkItemFormService interface

Pacote:

azure-devops-extension-api

Serviço de host para interagir com o formulário de item de trabalho ativo no momento (item de trabalho exibido atualmente na interface do usuário). O serviço de formulário depende do contexto do item de trabalho ativo atual. Gerará um erro quando não houver nenhum item de trabalho aberto.

Métodos

addWorkItemRelations(WorkItemRelation[])	Adiciona links de outros itens de trabalho ou artefatos (por exemplo, commits, hiperlinks) ao item de trabalho. No momento, não há suporte para anexos nessa função.
beginSaveWorkItem(() => void, () => void)	@deprecated: use salvar
clearError()	Limpa o erro definido pelo método setError e desbloqueia o salvamento 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 usuário ou por uma regra de item de trabalho e estão em um estado sujo.
getFields()	Obtém campos de item 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 a 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 em um estado inválido de acordo com as regras do item de trabalho. Esses campos precisam ser alterados antes que o item de trabalho possa ser salvo.
getRevision()	Obtém a revisão mais recente do item de trabalho ativo.
getWorkItemRelations()	Retorna uma matriz de links de item de trabalho para outros itens de trabalho ou artefatos (por exemplo, confirmações, hiperlinks). Atualmente, não há suporte para anexos nessa função.
getWorkItemRelationTypes()	Retorna uma matriz de tipos de relação de item de trabalho.
getWorkItemResourceUrl(number)	Retorna a URL da API REST do recurso de item de trabalho especificado.
hasActiveWorkItem()	Retorna true se o item de trabalho ativo disponível.
isDirty()	Retornará true se o item de trabalho ativo for sujo.
isNew()	Retornará true se o item de trabalho ativo for novo.
isValid()	Retornará true se os campos de item de trabalho ativos forem todos válidos.
refresh()	Atualiza o item de trabalho ativo. Avisará o usuário se o item de trabalho for sujo.
removeWorkItemRelations(WorkItemRelation[])	Remove links para outros itens de trabalho ou artefatos (por exemplo, confirmações, hiperlinks) do item de trabalho. Atualmente, não há suporte para anexos nessa função.
reset()	Redefina as alterações no item de trabalho ativo. Solicitará que o usuário confirme.
save()	Salva o item de trabalho ativo.
setError(string)	Marca o item de trabalho como inválido e desabilitar o salvamento 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 do método

addWorkItemRelations(WorkItemRelation[])

Adiciona links de outros itens de trabalho ou artefatos (por exemplo, commits, hiperlinks) ao item de trabalho. No momento, não há suporte para anexos nessa função.

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

Parâmetros

workItemRelations

WorkItemRelation[]

Links de item de trabalho a serem adicionados.

Retornos

Promise<void>

Uma promessa vazia.

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

@deprecated: use salvar

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

Parâmetros

successCallback

() => void

errorCallback

() => void

Retornos

Promise<void>

clearError()

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

function clearError(): Promise<void>

Retornos

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

Retornos

Promise<Object[]>

Uma promessa que retorna uma matriz de valores permitidos.

getDirtyFields(boolean)

Obtém campos que foram alterados pelo usuário ou por uma regra de item de trabalho e estão em um estado sujo.

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

Parâmetros

includeSystemChanges

boolean

Um valor booliano que indica se o resultado deve incluir alterações definidas por regras de item de trabalho.

Retornos

Promise<WorkItemField[]>

Uma promessa que retorna uma matriz de sujo campos de item de trabalho.

getFields()

Obtém campos de item de trabalho ativos.

function getFields(): Promise<WorkItemField[]>

Retornos

Promise<WorkItemField[]>

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

getFieldValue(string, boolean)

Aviso

Essa 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 false, obtém valores de campo não salvos. O padrão é false.

Retornos

Promise<Object>

Uma promessa que retorna o valor do campo de 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 item de trabalho

Retornos

Promise<Object>

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

getFieldValues(string[], boolean)

Aviso

Essa 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[]

Um arrary de nomes de referência de campo

returnOriginalValue

boolean

(Opcional) Se false, obtém valores de campo não salvos. O padrão é false.

Retornos

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

Uma promessa que retorna um dicionário de valores de campo de item 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[]

Um arrary de nomes de referência de campo

options

WorkItemOptions

opções de item de trabalho

Retornos

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

Uma promessa que retorna um dicionário de valores de campo de item de trabalho (refName para pares de valores).

getId()

Obtém a ID do item de trabalho ativo.

function getId(): Promise<number>

Retornos

Promise<number>

Uma promessa que retorna a 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 item de trabalho

Retornos

Promise<IdentityRef>

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

getInvalidFields()

Obtém campos que estão em um estado inválido de acordo com as regras do item de trabalho. Esses campos precisam ser alterados antes que o item de trabalho possa ser salvo.

function getInvalidFields(): Promise<WorkItemField[]>

Retornos

Promise<WorkItemField[]>

Uma promessa que retorna uma matriz de campos de item de trabalho inválidos.

getRevision()

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

function getRevision(): Promise<number>

Retornos

Promise<number>

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

getWorkItemRelations()

Retorna uma matriz de links de item de trabalho para outros itens de trabalho ou artefatos (por exemplo, confirmações, hiperlinks). Atualmente, não há suporte para anexos nessa função.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Retornos

Promise<WorkItemRelation[]>

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

getWorkItemRelationTypes()

Retorna uma matriz de tipos de relação de item de trabalho.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Retornos

Promise<WorkItemRelationType[]>

Uma promessa que retorna uma matriz de tipos de relação de item de trabalho.

getWorkItemResourceUrl(number)

Retorna a 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 a URL do recurso é solicitada.

Retornos

Promise<string>

Uma promessa que retorna a URL de recurso solicitada do item de trabalho.

hasActiveWorkItem()

Retorna true se o item de trabalho ativo disponível.

function hasActiveWorkItem(): Promise<boolean>

Retornos

Promise<boolean>

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

isDirty()

Retornará true se o item de trabalho ativo for sujo.

function isDirty(): Promise<boolean>

Retornos

Promise<boolean>

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

isNew()

Retornará true se o item de trabalho ativo for novo.

function isNew(): Promise<boolean>

Retornos

Promise<boolean>

Uma promessa que retorna um valor booliano indica se o item de trabalho ativo é novo.

isValid()

Retornará true se os campos de item de trabalho ativos forem todos válidos.

function isValid(): Promise<boolean>

Retornos

Promise<boolean>

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

refresh()

Atualiza o item de trabalho ativo. Avisará o usuário se o item de trabalho for sujo.

function refresh(): Promise<void>

Retornos

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Remove links para outros itens de trabalho ou artefatos (por exemplo, confirmações, hiperlinks) do item de trabalho. Atualmente, não há suporte para anexos nessa função.

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

Parâmetros

workItemRelations

WorkItemRelation[]

Links de item de trabalho a serem removidos.

Retornos

Promise<void>

Uma promessa vazia.

reset()

Redefina as alterações no item de trabalho ativo. Solicitará que o usuário confirme.

function reset(): Promise<void>

Retornos

Promise<void>

save()

Salva o item de trabalho ativo.

function save(): Promise<void>

Retornos

Promise<void>

Uma promessa que será resolvida se o item de trabalho for salvo com êxito e rejeitado se falhar.

setError(string)

Marca o item de trabalho como inválido e desabilitar o salvamento do item de trabalho no formulário.

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

Parâmetros

errorMessage

string

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

Retornos

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

Retornos

Promise<boolean>

Uma promessa que retorna um valor booliano 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

Retornos

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

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