IWorkItemFormService interface

الحزمة:

azure-devops-extension-api

خدمة المضيف للتفاعل مع نموذج عنصر العمل النشط حاليا (عنصر العمل المعروض حاليا في واجهة المستخدم). تعتمد خدمة النموذج على سياق عنصر العمل النشط الحالي. سيؤدي إلى ظهور خطأ عند عدم وجود عنصر عمل مفتوح.

الأساليب

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()	الحصول على معرف عنصر العمل النشط.
getIdentityFieldValue(string, WorkItemOptions)	الحصول على قيمة حقل الهوية لعنصر العمل النشط.
getInvalidFields()	يحصل على الحقول الموجودة في حالة غير صحيحة وفقا لقواعد عنصر العمل. يجب تغيير هذه الحقول قبل حفظ عنصر العمل.
getRevision()	الحصول على أحدث مراجعة لعنصر العمل النشط.
getWorkItemRelations()	إرجاع صفيف من ارتباطات عناصر العمل إلى عناصر عمل أو أدوات أخرى (على سبيل المثال، التثبيتات، الارتباطات التشعبية). المرفق غير معتمد حاليا بواسطة هذه الدالة.
getWorkItemRelationTypes()	إرجاع صفيف من أنواع علاقة عناصر العمل.
getWorkItemResourceUrl(number)	إرجاع عنوان URL لواجهة برمجة تطبيقات REST لمورد عنصر العمل المحدد.
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[]>

وعد يرجع صفيفا من القيم المسموح بها.

getDirtyFields(boolean)

يحصل على الحقول التي تم تغييرها إما بواسطة المستخدم أو بواسطة قاعدة عنصر عمل وهي في حالة غير صحيحة.

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

المعلمات

includeSystemChanges

boolean

قيمة منطقية تشير إلى ما إذا كانت النتيجة يجب أن تتضمن تغييرات تم تعيينها بواسطة قواعد عنصر العمل.

المرتجعات

Promise<WorkItemField[]>

وعد يرجع صفيفا من حقول عناصر العمل القذرة.

getFields()

الحصول على حقول عناصر العمل النشطة.

function getFields(): Promise<WorkItemField[]>

المرتجعات

Promise<WorkItemField[]>

وعد بإرجاع صفيف من حقل عنصر العمل.

getFieldValue(string, boolean)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Please use options instead of returnOriginalValue

الحصول على قيمة الحقل لعنصر العمل النشط.

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

المعلمات

fieldReferenceName

string

اسم مرجع الحقل

returnOriginalValue

boolean

(اختياري) إذا كانت خاطئة، تحصل على قيم حقول غير محفوظة. الافتراضي هو خطأ.

المرتجعات

Promise<Object>

وعد يرجع قيمة حقل عنصر العمل.

getFieldValue(string, WorkItemOptions)

الحصول على قيمة الحقل لعنصر العمل النشط.

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

المعلمات

fieldReferenceName

string

اسم مرجع الحقل

options

WorkItemOptions

خيارات عنصر العمل

المرتجعات

Promise<Object>

وعد يرجع قيمة حقل عنصر العمل.

getFieldValues(string[], boolean)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Please use options instead of returnOriginalValue

الحصول على قيم الحقول لعنصر العمل النشط.

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

المعلمات

fieldReferenceNames

string[]

عدد صحيح من أسماء مراجع الحقول

returnOriginalValue

boolean

(اختياري) إذا كانت خاطئة، تحصل على قيم حقول غير محفوظة. الافتراضي هو خطأ.

المرتجعات

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()

الحصول على معرف عنصر العمل النشط.

function getId(): Promise<number>

المرتجعات

Promise<number>

وعد يرجع معرف عنصر العمل النشط.

getIdentityFieldValue(string, WorkItemOptions)

الحصول على قيمة حقل الهوية لعنصر العمل النشط.

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>

وعد بإرجاع معرف المراجعة الأخير لعنصر العمل النشط.

getWorkItemRelations()

إرجاع صفيف من ارتباطات عناصر العمل إلى عناصر عمل أو أدوات أخرى (على سبيل المثال، التثبيتات، الارتباطات التشعبية). المرفق غير معتمد حاليا بواسطة هذه الدالة.

function getWorkItemRelations(): Promise<WorkItemRelation[]>

المرتجعات

Promise<WorkItemRelation[]>

وعد بإرجاع صفيف من علاقات عنصر العمل لعنصر العمل النشط.

getWorkItemRelationTypes()

إرجاع صفيف من أنواع علاقة عناصر العمل.

function getWorkItemRelationTypes(): Promise<WorkItemRelationType[]>

المرتجعات

Promise<WorkItemRelationType[]>

وعد يرجع صفيفا من أنواع علاقة عناصر العمل.

getWorkItemResourceUrl(number)

إرجاع عنوان URL لواجهة برمجة تطبيقات REST لمورد عنصر العمل المحدد.

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

المعلمات

workItemId

number

معرف عنصر العمل الذي يتم طلب عنوان url للمورد له.

المرتجعات

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 إلى أزواج النتائج).