IWorkItemFormService interface

Paket:

azure-devops-extension-api

Şu anda etkin olan iş öğesi formuyla etkileşim kurmak için konak hizmeti (şu anda kullanıcı arabiriminde görüntülenen iş öğesi). Form hizmeti, geçerli etkin iş öğesi bağlamına bağlıdır. Açık bir iş öğesi olmadığında bir hata atar.

Yöntemler

addWorkItemRelations(WorkItemRelation[])	İş öğesine başka bir iş öğesinin veya yapıtların (örneğin, işlemeler, köprüler) bağlantılarını ekler. Ek şu anda bu işlev tarafından desteklenmemektedir.
beginSaveWorkItem(() => void, () => void)	@deprecated: Lütfen kaydet'i kullanın
clearError()	setError yöntemiyle ayarlanan hatayı temizler ve iş öğesinin formda kaydedilmesinin engelini kaldırır.
getAllowedFieldValues(string)	Etkin iş öğesindeki alan için izin verilen değerleri alır.
getDirtyFields(boolean)	Kullanıcı tarafından veya bir iş öğesi kuralı tarafından değiştirilen ve kirli durumda olan alanları alır.
getFields()	Etkin iş öğesi alanlarını alır.
getFieldValue(string, boolean)	Etkin iş öğesinin alan değerini alır.
getFieldValue(string, WorkItemOptions)	Etkin iş öğesinin alan değerini alır.
getFieldValues(string[], boolean)	Etkin iş öğesinin alan değerlerini alır.
getFieldValues(string[], WorkItemOptions)	Etkin iş öğesinin alan değerlerini alır.
getId()	Etkin iş öğesinin kimliğini alır.
getIdentityFieldValue(string, WorkItemOptions)	Etkin iş öğesinin kimlik alanı değerini alır.
getInvalidFields()	İş öğesi kurallarına göre geçersiz durumda olan alanları alır. İş öğesinin kaydedilebilmesi için bu alanların değiştirilmesi gerekir.
getRevision()	Etkin iş öğesinin en son revizyonunu alır.
getWorkItemRelations()	Diğer iş öğelerine veya yapıtlara (örneğin, işlemeler, köprüler) bir dizi iş öğesi bağlantısı döndürür. Ek şu anda bu işlev tarafından desteklenmemektedir.
getWorkItemRelationTypes()	İş öğesi ilişki türlerinin bir dizisini döndürür.
getWorkItemResourceUrl(number)	Belirtilen iş öğesi kaynağının REST API URL'sini döndürür.
hasActiveWorkItem()	Etkin iş öğesi varsa true döndürür.
isDirty()	Etkin iş öğesi kirliyse true döndürür.
isNew()	Etkin iş öğesi yeniyse true döndürür.
isValid()	Etkin iş öğesi alanlarının tümü geçerliyse true döndürür.
refresh()	Etkin iş öğesini yeniler. Kullanıcıya iş öğesinin kirli olup olmadığını sorar.
removeWorkItemRelations(WorkItemRelation[])	İş öğesinden başka bir iş öğesine veya yapıtlara (örneğin, işlemeler, köprüler) olan bağlantıları kaldırır. Ek şu anda bu işlev tarafından desteklenmemektedir.
reset()	Etkin iş öğesindeki tüm değişiklikleri sıfırlayın. Kullanıcıdan onaylamasını ister.
save()	Etkin iş öğesini kaydeder.
setError(string)	İş öğesini geçersiz olarak işaretler ve iş öğesinin forma kaydedilmesini devre dışı bırakır.
setFieldValue(string, Object)	Etkin iş öğesinin alan değerini ayarlar.
setFieldValues({[fieldName: string]: Object})	Etkin iş öğesinin alan değerlerini ayarlar.

Yöntem Ayrıntıları

addWorkItemRelations(WorkItemRelation[])

İş öğesine başka bir iş öğesinin veya yapıtların (örneğin, işlemeler, köprüler) bağlantılarını ekler. Ek şu anda bu işlev tarafından desteklenmemektedir.

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

Parametreler

workItemRelations

WorkItemRelation[]

Eklenecek iş öğesi bağlantıları.

Döndürülenler

Promise<void>

Boş bir vaat.

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

@deprecated: Lütfen kaydet'i kullanın

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

Parametreler

successCallback

() => void

errorCallback

() => void

Döndürülenler

Promise<void>

clearError()

setError yöntemiyle ayarlanan hatayı temizler ve iş öğesinin formda kaydedilmesinin engelini kaldırır.

function clearError(): Promise<void>

Döndürülenler

Promise<void>

getAllowedFieldValues(string)

Etkin iş öğesindeki alan için izin verilen değerleri alır.

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

Parametreler

fieldReferenceName

string

Alan başvuru adı

Döndürülenler

Promise<Object[]>

İzin verilen değerler dizisini döndüren bir söz.

getDirtyFields(boolean)

Kullanıcı tarafından veya bir iş öğesi kuralı tarafından değiştirilen ve kirli durumda olan alanları alır.

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

Parametreler

includeSystemChanges

boolean

Sonucun iş öğesi kuralları tarafından ayarlanan değişiklikleri içermesi gerekip gerekmediğini belirten bir boole değeri.

Döndürülenler

Promise<WorkItemField[]>

Bir dizi kirli iş öğesi alanı döndüren bir söz.

getFields()

Etkin iş öğesi alanlarını alır.

function getFields(): Promise<WorkItemField[]>

Döndürülenler

Promise<WorkItemField[]>

Bir iş öğesi alanı dizisi döndüren bir söz.

getFieldValue(string, boolean)

Uyarı

Bu API artık kullanım dışıdır.

Please use options instead of returnOriginalValue

Etkin iş öğesinin alan değerini alır.

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

Parametreler

fieldReferenceName

string

Alan başvuru adı

returnOriginalValue

boolean

(İsteğe bağlı) false ise, kaydedilmemiş alan değerlerini alır. Varsayılan değer false'tur.

Döndürülenler

Promise<Object>

İş öğesi alanının değerini döndüren bir söz.

getFieldValue(string, WorkItemOptions)

Etkin iş öğesinin alan değerini alır.

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

Parametreler

fieldReferenceName

string

Alan başvuru adı

options

WorkItemOptions

İş öğesi seçenekleri

Döndürülenler

Promise<Object>

İş öğesi alanının değerini döndüren bir söz.

getFieldValues(string[], boolean)

Uyarı

Bu API artık kullanım dışıdır.

Please use options instead of returnOriginalValue

Etkin iş öğesinin alan değerlerini alır.

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

Parametreler

fieldReferenceNames

string[]

Alan başvuru adları listesi

returnOriginalValue

boolean

(İsteğe bağlı) false ise, kaydedilmemiş alan değerlerini alır. Varsayılan değer false'tur.

Döndürülenler

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

İş öğesi alanı değerlerinin sözlüğünü döndüren bir söz (refName'den değer çiftlerine).

getFieldValues(string[], WorkItemOptions)

Etkin iş öğesinin alan değerlerini alır.

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

Parametreler

fieldReferenceNames

string[]

Alan başvuru adları listesi

options

WorkItemOptions

İş öğesi seçenekleri

Döndürülenler

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

İş öğesi alanı değerlerinin sözlüğünü döndüren bir söz (refName'den değer çiftlerine).

getId()

Etkin iş öğesinin kimliğini alır.

function getId(): Promise<number>

Döndürülenler

Promise<number>

Etkin iş öğesi kimliğini döndüren bir söz.

getIdentityFieldValue(string, WorkItemOptions)

Etkin iş öğesinin kimlik alanı değerini alır.

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

Parametreler

fieldReferenceName

string

Alan başvuru adı

options

WorkItemOptions

İş öğesi seçenekleri

Döndürülenler

Promise<IdentityRef>

İş öğesi alanının değerini döndüren bir söz.

getInvalidFields()

İş öğesi kurallarına göre geçersiz durumda olan alanları alır. İş öğesinin kaydedilebilmesi için bu alanların değiştirilmesi gerekir.

function getInvalidFields(): Promise<WorkItemField[]>

Döndürülenler

Promise<WorkItemField[]>

Geçersiz iş öğesi alanlarının bir dizisini döndüren bir söz.

getRevision()

Etkin iş öğesinin en son revizyonunu alır.

function getRevision(): Promise<number>

Döndürülenler

Promise<number>

Etkin iş öğesinin en son revizyon kimliğini döndüren bir söz.

getWorkItemRelations()

Diğer iş öğelerine veya yapıtlara (örneğin, işlemeler, köprüler) bir dizi iş öğesi bağlantısı döndürür. Ek şu anda bu işlev tarafından desteklenmemektedir.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Döndürülenler

Promise<WorkItemRelation[]>

Etkin iş öğesinin iş öğesi ilişkilerinin bir dizisini döndüren bir söz.

getWorkItemRelationTypes()

İş öğesi ilişki türlerinin bir dizisini döndürür.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Döndürülenler

Promise<WorkItemRelationType[]>

İş öğesi ilişki türlerinin bir dizisini döndüren bir söz.

getWorkItemResourceUrl(number)

Belirtilen iş öğesi kaynağının REST API URL'sini döndürür.

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

Parametreler

workItemId

number

Kaynak URL'sinin istendiği iş öğesinin kimliği.

Döndürülenler

Promise<string>

İş öğesinin istenen kaynak URL'sini döndüren bir söz.

hasActiveWorkItem()

Etkin iş öğesi varsa true döndürür.

function hasActiveWorkItem(): Promise<boolean>

Döndürülenler

Promise<boolean>

Boole değeri döndüren bir söz, etkin iş öğesinin kullanılabilir olup olmadığını gösterir.

isDirty()

Etkin iş öğesi kirliyse true döndürür.

function isDirty(): Promise<boolean>

Döndürülenler

Promise<boolean>

Boole değeri döndüren bir söz, etkin iş öğesinin kirli olup olmadığını gösterir.

isNew()

Etkin iş öğesi yeniyse true döndürür.

function isNew(): Promise<boolean>

Döndürülenler

Promise<boolean>

Boole değeri döndüren bir söz, etkin iş öğesinin yeni olup olmadığını gösterir.

isValid()

Etkin iş öğesi alanlarının tümü geçerliyse true döndürür.

function isValid(): Promise<boolean>

Döndürülenler

Promise<boolean>

Boole değeri döndüren bir söz, tüm alan değerlerinin geçerli olup olmadığını gösterir.

refresh()

Etkin iş öğesini yeniler. Kullanıcıya iş öğesinin kirli olup olmadığını sorar.

function refresh(): Promise<void>

Döndürülenler

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

İş öğesinden başka bir iş öğesine veya yapıtlara (örneğin, işlemeler, köprüler) olan bağlantıları kaldırır. Ek şu anda bu işlev tarafından desteklenmemektedir.

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

Parametreler

workItemRelations

WorkItemRelation[]

Kaldırılacak iş öğesi bağlantıları.

Döndürülenler

Promise<void>

Boş bir vaat.

reset()

Etkin iş öğesindeki tüm değişiklikleri sıfırlayın. Kullanıcıdan onaylamasını ister.

function reset(): Promise<void>

Döndürülenler

Promise<void>

save()

Etkin iş öğesini kaydeder.

function save(): Promise<void>

Döndürülenler

Promise<void>

İş öğesi başarıyla kaydedilirse çözümlenen ve başarısız olursa reddedilen bir söz.

setError(string)

İş öğesini geçersiz olarak işaretler ve iş öğesinin forma kaydedilmesini devre dışı bırakır.

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

Parametreler

errorMessage

string

İş öğesi formunun en üstünde gösterilecek özel bir hata iletisi.

Döndürülenler

Promise<void>

setFieldValue(string, Object)

Etkin iş öğesinin alan değerini ayarlar.

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

Parametreler

fieldReferenceName

string

Alan başvuru adı

value

Object

Alan değeri

Döndürülenler

Promise<boolean>

Boole değeri döndüren bir söz, işlevin başarıyla tamamlanıp tamamlanmadığını gösterir.

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

Etkin iş öğesinin alan değerlerini ayarlar.

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

Parametreler

fields

{[fieldName: string]: Object}

refName/values alan sözlüğü

Döndürülenler

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

Alan değeri güncelleştirme sonuçları sözlüğünü döndüren bir söz (sonuç çiftlerine refName).