IWorkItemFormService interface

Paket:

azure-devops-extension-api

Layanan host untuk berinteraksi dengan formulir item kerja yang saat ini aktif (item kerja yang saat ini ditampilkan di UI). Layanan formulir bergantung pada konteks item kerja aktif saat ini. Akan melemparkan kesalahan ketika tidak ada item kerja yang terbuka.

Metode

addWorkItemRelations(WorkItemRelation[])	Menambahkan tautan item kerja atau artefak lain (misalnya penerapan, hyperlink) ke item kerja. Lampiran saat ini tidak didukung oleh fungsi ini.
beginSaveWorkItem(() => void, () => void)	@deprecated: Silakan gunakan simpan
clearError()	Menghapus kesalahan yang ditetapkan oleh metode setError dan membuka blokir penyimpanan item kerja dalam formulir.
getAllowedFieldValues(string)	Mendapatkan nilai yang diizinkan untuk bidang pada item kerja aktif.
getDirtyFields(boolean)	Mendapatkan bidang yang telah diubah baik oleh pengguna atau oleh aturan item kerja dan dalam status kotor.
getFields()	Mendapatkan bidang item kerja aktif.
getFieldValue(string, boolean)	Mendapatkan nilai bidang item kerja aktif.
getFieldValue(string, WorkItemOptions)	Mendapatkan nilai bidang item kerja aktif.
getFieldValues(string[], boolean)	Mendapatkan nilai bidang item kerja aktif.
getFieldValues(string[], WorkItemOptions)	Mendapatkan nilai bidang item kerja aktif.
getId()	Mendapatkan id item kerja aktif.
getIdentityFieldValue(string, WorkItemOptions)	Mendapatkan nilai bidang identitas item kerja aktif.
getInvalidFields()	Mendapatkan bidang yang berada dalam status tidak valid sesuai dengan aturan item kerja. Bidang ini perlu diubah sebelum item kerja dapat disimpan.
getRevision()	Mendapatkan revisi terbaru item kerja aktif.
getWorkItemRelations()	Mengembalikan array tautan item kerja ke item kerja atau artefak lain (misalnya penerapan, hyperlink). Lampiran saat ini tidak didukung oleh fungsi ini.
getWorkItemRelationTypes()	Mengembalikan array jenis relasi item kerja.
getWorkItemResourceUrl(number)	Mengembalikan url REST API dari sumber daya item kerja yang ditentukan.
hasActiveWorkItem()	Mengembalikan true jika item kerja aktif tersedia.
isDirty()	Mengembalikan true jika item kerja aktif kotor.
isNew()	Mengembalikan true jika item kerja aktif baru.
isValid()	Mengembalikan true jika bidang item kerja aktif semuanya valid.
refresh()	Me-refresh item kerja aktif. Akan meminta pengguna jika item kerja kotor.
removeWorkItemRelations(WorkItemRelation[])	Menghapus tautan ke item kerja atau artefak lain (misalnya penerapan, hyperlink) dari item kerja. Lampiran saat ini tidak didukung oleh fungsi ini.
reset()	Atur ulang perubahan apa pun pada item kerja aktif. Akan meminta pengguna untuk mengonfirmasi.
save()	Menyimpan item kerja aktif.
setError(string)	Menandai item kerja sebagai tidak valid dan menonaktifkan penyimpanan item kerja pada formulir.
setFieldValue(string, Object)	Mengatur nilai bidang item kerja aktif.
setFieldValues({[fieldName: string]: Object})	Mengatur nilai bidang item kerja aktif.

Detail Metode

addWorkItemRelations(WorkItemRelation[])

Menambahkan tautan item kerja atau artefak lain (misalnya penerapan, hyperlink) ke item kerja. Lampiran saat ini tidak didukung oleh fungsi ini.

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

Parameter

workItemRelations

WorkItemRelation[]

Tautan item kerja untuk ditambahkan.

Mengembalikan

Promise<void>

Janji kosong.

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

@deprecated: Silakan gunakan simpan

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

Parameter

successCallback

() => void

errorCallback

() => void

Mengembalikan

Promise<void>

clearError()

Menghapus kesalahan yang ditetapkan oleh metode setError dan membuka blokir penyimpanan item kerja dalam formulir.

function clearError(): Promise<void>

Mengembalikan

Promise<void>

getAllowedFieldValues(string)

Mendapatkan nilai yang diizinkan untuk bidang pada item kerja aktif.

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

Parameter

fieldReferenceName

string

Nama referensi bidang

Mengembalikan

Promise<Object[]>

Janji yang mengembalikan array nilai yang diizinkan.

getDirtyFields(boolean)

Mendapatkan bidang yang telah diubah baik oleh pengguna atau oleh aturan item kerja dan dalam status kotor.

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

Parameter

includeSystemChanges

boolean

Nilai boolean yang menunjukkan apakah hasilnya harus menyertakan perubahan yang ditetapkan oleh aturan item kerja.

Mengembalikan

Promise<WorkItemField[]>

Janji yang mengembalikan array bidang item kerja kotor.

getFields()

Mendapatkan bidang item kerja aktif.

function getFields(): Promise<WorkItemField[]>

Mengembalikan

Promise<WorkItemField[]>

Janji yang mengembalikan array bidang item kerja.

getFieldValue(string, boolean)

Peringatan

API ini sudah tidak digunakan lagi.

Please use options instead of returnOriginalValue

Mendapatkan nilai bidang item kerja aktif.

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

Parameter

fieldReferenceName

string

Nama referensi bidang

returnOriginalValue

boolean

(Opsional) Jika false, mendapatkan nilai bidang yang tidak disimpan. Secara default adalah false.

Mengembalikan

Promise<Object>

Janji yang mengembalikan nilai bidang item kerja.

getFieldValue(string, WorkItemOptions)

Mendapatkan nilai bidang item kerja aktif.

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

Parameter

fieldReferenceName

string

Nama referensi bidang

options

WorkItemOptions

Opsi item kerja

Mengembalikan

Promise<Object>

Janji yang mengembalikan nilai bidang item kerja.

getFieldValues(string[], boolean)

Peringatan

API ini sudah tidak digunakan lagi.

Please use options instead of returnOriginalValue

Mendapatkan nilai bidang item kerja aktif.

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

Parameter

fieldReferenceNames

string[]

Tunggakan nama referensi bidang

returnOriginalValue

boolean

(Opsional) Jika false, mendapatkan nilai bidang yang tidak disimpan. Secara default adalah false.

Mengembalikan

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

Janji yang mengembalikan kamus nilai bidang item kerja (refName ke pasangan nilai).

getFieldValues(string[], WorkItemOptions)

Mendapatkan nilai bidang item kerja aktif.

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

Parameter

fieldReferenceNames

string[]

Tunggakan nama referensi bidang

options

WorkItemOptions

Opsi item kerja

Mengembalikan

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

Janji yang mengembalikan kamus nilai bidang item kerja (refName ke pasangan nilai).

getId()

Mendapatkan id item kerja aktif.

function getId(): Promise<number>

Mengembalikan

Promise<number>

Janji yang mengembalikan id item kerja aktif.

getIdentityFieldValue(string, WorkItemOptions)

Mendapatkan nilai bidang identitas item kerja aktif.

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

Parameter

fieldReferenceName

string

Nama referensi bidang

options

WorkItemOptions

Opsi item kerja

Mengembalikan

Promise<IdentityRef>

Janji yang mengembalikan nilai bidang item kerja.

getInvalidFields()

Mendapatkan bidang yang berada dalam status tidak valid sesuai dengan aturan item kerja. Bidang ini perlu diubah sebelum item kerja dapat disimpan.

function getInvalidFields(): Promise<WorkItemField[]>

Mengembalikan

Promise<WorkItemField[]>

Janji yang mengembalikan array bidang item kerja yang tidak valid.

getRevision()

Mendapatkan revisi terbaru item kerja aktif.

function getRevision(): Promise<number>

Mengembalikan

Promise<number>

Janji yang mengembalikan id revisi terbaru item kerja aktif.

getWorkItemRelations()

Mengembalikan array tautan item kerja ke item kerja atau artefak lain (misalnya penerapan, hyperlink). Lampiran saat ini tidak didukung oleh fungsi ini.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

Mengembalikan

Promise<WorkItemRelation[]>

Janji yang mengembalikan array relasi item kerja item kerja aktif.

getWorkItemRelationTypes()

Mengembalikan array jenis relasi item kerja.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

Mengembalikan

Promise<WorkItemRelationType[]>

Janji yang mengembalikan array jenis relasi item kerja.

getWorkItemResourceUrl(number)

Mengembalikan url REST API dari sumber daya item kerja yang ditentukan.

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

Parameter

workItemId

number

Id item kerja yang diminta url sumber daya.

Mengembalikan

Promise<string>

Janji yang mengembalikan url sumber daya yang diminta dari item kerja.

hasActiveWorkItem()

Mengembalikan true jika item kerja aktif tersedia.

function hasActiveWorkItem(): Promise<boolean>

Mengembalikan

Promise<boolean>

Janji yang mengembalikan nilai boolean menunjukkan apakah item kerja aktif tersedia.

isDirty()

Mengembalikan true jika item kerja aktif kotor.

function isDirty(): Promise<boolean>

Mengembalikan

Promise<boolean>

Janji yang mengembalikan nilai boolean menunjukkan apakah item kerja aktif kotor.

isNew()

Mengembalikan true jika item kerja aktif baru.

function isNew(): Promise<boolean>

Mengembalikan

Promise<boolean>

Janji yang mengembalikan nilai boolean menunjukkan apakah item kerja aktif baru.

isValid()

Mengembalikan true jika bidang item kerja aktif semuanya valid.

function isValid(): Promise<boolean>

Mengembalikan

Promise<boolean>

Janji yang mengembalikan nilai boolean menunjukkan apakah semua nilai bidang valid.

refresh()

Me-refresh item kerja aktif. Akan meminta pengguna jika item kerja kotor.

function refresh(): Promise<void>

Mengembalikan

Promise<void>

removeWorkItemRelations(WorkItemRelation[])

Menghapus tautan ke item kerja atau artefak lain (misalnya penerapan, hyperlink) dari item kerja. Lampiran saat ini tidak didukung oleh fungsi ini.

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

Parameter

workItemRelations

WorkItemRelation[]

Tautan item kerja untuk dihapus.

Mengembalikan

Promise<void>

Janji kosong.

reset()

Atur ulang perubahan apa pun pada item kerja aktif. Akan meminta pengguna untuk mengonfirmasi.

function reset(): Promise<void>

Mengembalikan

Promise<void>

save()

Menyimpan item kerja aktif.

function save(): Promise<void>

Mengembalikan

Promise<void>

Janji yang diselesaikan jika item kerja berhasil disimpan dan ditolak jika gagal.

setError(string)

Menandai item kerja sebagai tidak valid dan menonaktifkan penyimpanan item kerja pada formulir.

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

Parameter

errorMessage

string

Pesan kesalahan kustom yang akan ditampilkan di atas formulir item kerja.

Mengembalikan

Promise<void>

setFieldValue(string, Object)

Mengatur nilai bidang item kerja aktif.

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

Parameter

fieldReferenceName

string

Nama referensi bidang

value

Object

Nilai bidang

Mengembalikan

Promise<boolean>

Janji yang mengembalikan nilai boolean menunjukkan apakah fungsi berhasil diselesaikan.

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

Mengatur nilai bidang item kerja aktif.

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

Parameter

fields

{[fieldName: string]: Object}

Kamus bidang refName/nilai

Mengembalikan

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

Janji yang mengembalikan kamus hasil pembaruan nilai bidang (refName ke pasangan hasil).