IWorkItemFormService interface

패키지:

azure-devops-extension-api

현재 활성 작업 항목 양식(현재 UI에 표시된 작업 항목)과 상호 작용하기 위한 호스트 서비스입니다. 양식 서비스는 현재 활성 작업 항목 컨텍스트에 따라 달라집니다. 열려 있는 작업 항목이 없으면 오류가 발생합니다.

메서드

addWorkItemRelations(WorkItemRelation[])	다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)의 링크를 작업 항목에 추가합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.
beginSaveWorkItem(() => void, () => void)	@deprecated: 저장을 사용하세요.
clearError()	setError 메서드로 설정된 오류를 지우고 양식에서 작업 항목의 저장을 차단 해제합니다.
getAllowedFieldValues(string)	활성 작업 항목의 필드에 허용되는 값을 가져옵니다.
getDirtyFields(boolean)	사용자 또는 작업 항목 규칙에 의해 변경되고 더티 상태에 있는 필드를 가져옵니다.
getFields()	활성 작업 항목 필드를 가져옵니다.
getFieldValue(string, boolean)	활성 작업 항목의 필드 값을 가져옵니다.
getFieldValue(string, WorkItemOptions)	활성 작업 항목의 필드 값을 가져옵니다.
getFieldValues(string[], boolean)	활성 작업 항목의 필드 값을 가져옵니다.
getFieldValues(string[], WorkItemOptions)	활성 작업 항목의 필드 값을 가져옵니다.
getId()	활성 작업 항목의 ID를 가져옵니다.
getIdentityFieldValue(string, WorkItemOptions)	활성 작업 항목의 ID 필드 값을 가져옵니다.
getInvalidFields()	작업 항목 규칙에 따라 잘못된 상태에 있는 필드를 가져옵니다. 작업 항목을 저장하려면 이러한 필드를 변경해야 합니다.
getRevision()	활성 작업 항목의 최신 수정 버전을 가져옵니다.
getWorkItemRelations()	다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)에 대한 작업 항목 링크의 배열을 반환합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.
getWorkItemRelationTypes()	작업 항목 관계 형식의 배열을 반환합니다.
getWorkItemResourceUrl(number)	지정된 작업 항목 리소스의 REST API URL을 반환합니다.
hasActiveWorkItem()	활성 작업 항목을 사용할 수 있는 경우 true를 반환합니다.
isDirty()	활성 작업 항목이 더티 경우 true를 반환합니다.
isNew()	현재 작업 항목이 새 항목이면 true를 반환합니다.
isValid()	활성 작업 항목 필드가 모두 유효한 경우 true를 반환합니다.
refresh()	활성 작업 항목을 새로 고칩니다. 작업 항목이 더티 경우 사용자에게 메시지를 표시합니다.
removeWorkItemRelations(WorkItemRelation[])	작업 항목에서 다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)에 대한 링크를 제거합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.
reset()	활성 작업 항목의 변경 내용을 다시 설정합니다. 사용자에게 확인하라는 메시지를 표시합니다.
save()	활성 작업 항목을 저장합니다.
setError(string)	작업 항목을 잘못된 것으로 표시하고 양식에 작업 항목을 저장하지 않도록 설정합니다.
setFieldValue(string, Object)	활성 작업 항목의 필드 값을 설정합니다.
setFieldValues({[fieldName: string]: Object})	활성 작업 항목의 필드 값을 설정합니다.

메서드 세부 정보

addWorkItemRelations(WorkItemRelation[])

다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)의 링크를 작업 항목에 추가합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.

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

매개 변수

workItemRelations

WorkItemRelation[]

추가할 작업 항목 링크입니다.

반환

Promise<void>

빈 약속.

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

@deprecated: 저장을 사용하세요.

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

매개 변수

successCallback

() => void

errorCallback

() => void

반환

Promise<void>

clearError()

setError 메서드로 설정된 오류를 지우고 양식에서 작업 항목의 저장을 차단 해제합니다.

function clearError(): Promise<void>

반환

Promise<void>

getAllowedFieldValues(string)

활성 작업 항목의 필드에 허용되는 값을 가져옵니다.

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

매개 변수

fieldReferenceName

string

필드 참조 이름

반환

Promise<Object[]>

허용되는 값의 배열을 반환하는 promise입니다.

getDirtyFields(boolean)

사용자 또는 작업 항목 규칙에 의해 변경되고 더티 상태에 있는 필드를 가져옵니다.

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

매개 변수

includeSystemChanges

boolean

결과에 작업 항목 규칙에 의해 설정된 변경 내용이 포함되어야 하는지 여부를 나타내는 부울 값입니다.

반환

Promise<WorkItemField[]>

더티 작업 항목 필드의 배열을 반환하는 promise입니다.

getFields()

활성 작업 항목 필드를 가져옵니다.

function getFields(): Promise<WorkItemField[]>

반환

Promise<WorkItemField[]>

작업 항목 필드의 배열을 반환하는 promise입니다.

getFieldValue(string, boolean)

경고

이 API는 이제 사용되지 않습니다.

Please use options instead of returnOriginalValue

활성 작업 항목의 필드 값을 가져옵니다.

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

매개 변수

fieldReferenceName

string

필드 참조 이름

returnOriginalValue

boolean

(선택 사항) false이면 저장되지 않은 필드 값을 가져옵니다. 기본값은 false입니다.

반환

Promise<Object>

작업 항목 필드의 값을 반환하는 promise입니다.

getFieldValue(string, WorkItemOptions)

활성 작업 항목의 필드 값을 가져옵니다.

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

매개 변수

fieldReferenceName

string

필드 참조 이름

options

WorkItemOptions

작업 항목 옵션

반환

Promise<Object>

작업 항목 필드의 값을 반환하는 promise입니다.

getFieldValues(string[], boolean)

경고

이 API는 이제 사용되지 않습니다.

Please use options instead of returnOriginalValue

활성 작업 항목의 필드 값을 가져옵니다.

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

매개 변수

fieldReferenceNames

string[]

필드 참조 이름의 배열

returnOriginalValue

boolean

(선택 사항) false이면 저장되지 않은 필드 값을 가져옵니다. 기본값은 false입니다.

반환

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

작업 항목 필드 값의 사전(값 쌍에 refName)을 반환하는 프라미스입니다.

getFieldValues(string[], WorkItemOptions)

활성 작업 항목의 필드 값을 가져옵니다.

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

매개 변수

fieldReferenceNames

string[]

필드 참조 이름의 배열

options

WorkItemOptions

작업 항목 옵션

반환

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

작업 항목 필드 값의 사전(값 쌍에 refName)을 반환하는 프라미스입니다.

getId()

활성 작업 항목의 ID를 가져옵니다.

function getId(): Promise<number>

반환

Promise<number>

활성 작업 항목 ID를 반환하는 프라미스입니다.

getIdentityFieldValue(string, WorkItemOptions)

활성 작업 항목의 ID 필드 값을 가져옵니다.

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

매개 변수

fieldReferenceName

string

필드 참조 이름

options

WorkItemOptions

작업 항목 옵션

반환

Promise<IdentityRef>

작업 항목 필드의 값을 반환하는 프라미스입니다.

getInvalidFields()

작업 항목 규칙에 따라 잘못된 상태에 있는 필드를 가져옵니다. 작업 항목을 저장하려면 이러한 필드를 변경해야 합니다.

function getInvalidFields(): Promise<WorkItemField[]>

반환

Promise<WorkItemField[]>

잘못된 작업 항목 필드의 배열을 반환하는 프라미스입니다.

getRevision()

활성 작업 항목의 최신 수정 버전을 가져옵니다.

function getRevision(): Promise<number>

반환

Promise<number>

활성 작업 항목의 최신 수정 ID를 반환하는 프라미스입니다.

getWorkItemRelations()

다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)에 대한 작업 항목 링크의 배열을 반환합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

반환

Promise<WorkItemRelation[]>

활성 작업 항목의 작업 항목 관계 배열을 반환하는 프라미스입니다.

getWorkItemRelationTypes()

작업 항목 관계 형식의 배열을 반환합니다.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

반환

Promise<WorkItemRelationType[]>

작업 항목 관계 형식의 배열을 반환하는 프라미스입니다.

getWorkItemResourceUrl(number)

지정된 작업 항목 리소스의 REST API URL을 반환합니다.

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

매개 변수

workItemId

number

리소스 URL이 요청된 작업 항목의 ID입니다.

반환

Promise<string>

작업 항목의 요청된 리소스 URL을 반환하는 프라미스입니다.

hasActiveWorkItem()

활성 작업 항목을 사용할 수 있는 경우 true를 반환합니다.

function hasActiveWorkItem(): Promise<boolean>

반환

Promise<boolean>

부울 값을 반환하는 프라미스는 활성 작업 항목을 사용할 수 있는지 여부를 나타냅니다.

isDirty()

활성 작업 항목이 더티 경우 true를 반환합니다.

function isDirty(): Promise<boolean>

반환

Promise<boolean>

부울 값을 반환하는 프라미스는 활성 작업 항목이 더티 여부를 나타냅니다.

isNew()

현재 작업 항목이 새 항목이면 true를 반환합니다.

function isNew(): Promise<boolean>

반환

Promise<boolean>

부울 값을 반환하는 프라미스는 활성 작업 항목이 새 항목인지 여부를 나타냅니다.

isValid()

활성 작업 항목 필드가 모두 유효한 경우 true를 반환합니다.

function isValid(): Promise<boolean>

반환

Promise<boolean>

부울 값을 반환하는 프라미스는 모든 필드 값이 유효한지 여부를 나타냅니다.

refresh()

활성 작업 항목을 새로 고칩니다. 작업 항목이 더티 경우 사용자에게 메시지를 표시합니다.

function refresh(): Promise<void>

반환

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

작업 항목에서 다른 작업 항목 또는 아티팩트(예: 커밋, 하이퍼링크)에 대한 링크를 제거합니다. 첨부 파일은 현재 이 함수에서 지원되지 않습니다.

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

매개 변수

workItemRelations

WorkItemRelation[]

제거할 작업 항목 링크입니다.

반환

Promise<void>

빈 약속입니다.

reset()

활성 작업 항목의 변경 내용을 다시 설정합니다. 사용자에게 확인하라는 메시지를 표시합니다.

function reset(): Promise<void>

반환

Promise<void>

save()

활성 작업 항목을 저장합니다.

function save(): Promise<void>

반환

Promise<void>

작업 항목이 성공적으로 저장되고 실패할 경우 거부되는 경우 해결되는 약속입니다.

setError(string)

작업 항목을 잘못된 것으로 표시하고 양식에 작업 항목을 저장하지 않도록 설정합니다.

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

매개 변수

errorMessage

string

작업 항목 양식 위에 표시되는 사용자 지정 오류 메시지입니다.

반환

Promise<void>

setFieldValue(string, Object)

활성 작업 항목의 필드 값을 설정합니다.

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

매개 변수

fieldReferenceName

string

필드 참조 이름

value

Object

필드 값

반환

Promise<boolean>

부울 값을 반환하는 프라미스는 함수가 성공적으로 완료되었는지 여부를 나타냅니다.

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

활성 작업 항목의 필드 값을 설정합니다.

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

매개 변수

fields

{[fieldName: string]: Object}

refName/values 필드 사전

반환

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

필드 값 업데이트 결과의 사전을 반환하는 프라미스입니다(결과 쌍에 refName).