Microsoft.TeamFoundation.WorkItemTracking.Client 命名空間

TeamFoundation.WorkItemTracking.Client 命名空間提供要求啟用用戶端電腦或應用程式與使用者劇本、需求、工作、Bug 和工作項目的其他類型的 API。

WorkItemStore 代表與工作項目儲存機制的連接在 Visual Studio Team Foundation Server的。 WorkItem 物件包含 Fields 儲存資料、 Attachment表示的檔案和 WorkItemLinks 連結至其他工作項目。 下列程式碼範例示範如何存取在工作項目存放區「使用者劇本」工作項目類型。

// Connect to the server and the store, and get the WorkItemType object
// for user stories from the team project where the user story will be created. 
Uri collectionUri = (args.Length < 1) new Uri("http://server:port/vdir/DefaultCollection") : new Uri(args[0]);
TfsTeamProjectCollection tpc = new TfsTeamProjectCollection(collectionUri);
WorkItemStore workItemStore = tpc.GetService<WorkItemStore>();
Project teamProject = workItemStore.Projects["DinnerNow"];
WorkItemType workItemType = teamProject.WorkItemTypes["User Story"];

Query 類別代表查詢對 WorkItemStore。 執行查詢傳回 WorkItemCollection，包含工作項目符合查詢。

WorkItemType 類別定義工作項目。 FieldDefinition 類別定義工作項目欄位。 WorkItemLinkType 類別定義 WorkItemLink，連接兩個工作項目。

您可以在 \Program Files\Microsoft Visual Studio 10.0\Common7\IDE\ReferenceAssemblies\v2.0 的 Microsoft.TeamFoundation.WorkItemTracking.Client 命名空間在 Team Explorer 安裝的電腦上，在下列組件:

• Microsoft.TeamFoundation.WorkItemTracking.Client.dll

類別

	類別	說明
	Administration	類別提供了管理工作可以在工作項目存放區。
	AllowedValuesCollection	表示 Field的有效值的清單。
	Attachment	描述工作項目的檔案附件。
	AttachmentCollection	儲存與工作項目的附件。
	BatchReadParameter	表示要加入至 BatchReadParameterCollection 的一個 ID 和修改為。
	BatchReadParameterCollection	表示從批次的讀取的參數集合。
	BatchSave	表示方法，並且批次儲存工作項目的屬性連結。
	BatchSaveError	分類描述單一工作項目批次儲存錯誤。
	BatchSaveFailedException	批次儲存失敗的錯誤的類別。
	BatchSaveRetryFailedException	為在批次儲存的重試時，所發生的錯誤分類。
	CancelableAsyncResult	類別用於存取非同步作業狀態或取消結果。
	CannotChangePageSizeException	已過時。類別提供了嘗試可以變更頁面大小錯誤。
	Category	說明工作項目類型的分類。
	CategoryCollection	類別物件的集合。
	ClientException	所有用戶端所產生之例外狀況的基底類別。
	ConnectionException	分類描述連接失敗到伺服器。
	CoreFieldReferenceNames	類別包含參考名稱核心欄位。
	CoreLinkTypeReferenceNames	類別包含參考名稱核心連結類型。
	DeniedOrNotExistException	分類描述拒絕存取則為項目不存在則為例外狀況。
	DisplayFieldList	表示從伺服器將被呼叫 WorkItemFieldDefinitions 的集合，此 WorkItemCollection 的 WorkItems 存取時。
	DuplicateBatchReadParameterException	複製中的類別讀取參數錯誤。
	DuplicateWorkItemException	已過時。重複工作項目錯誤的類別。
	ExternalLink	表示連結到其他工具。
	Field	表示 WorkItem的欄位。
	FieldCollection	表示 Fields 的集合。 WorkItem 物件的。
	FieldConflict
	FieldDefinition	表示 Field的屬性。
	FieldDefinitionCollection	描述 FieldDefinition 物件的集合。
	FieldDefinitionNotExistException	在欄位定義不存在時，提供自訂分類。
	FieldFilter	表示可用來塑造 FieldDefinition 物件的欄位值。用來與 FieldFilterList 一起篩選允許欄位的值。
	FieldFilterList	表示使用查詢，可以排序的欄位來篩選條件清單。
	FileAttachmentException	檔案附件錯誤的類別。
	Hyperlink	表示超連結。連結類型是 URL、UNC 或 BIS URI。
	IdentityNotExistException	會識別集合中不存在時，提供自訂分類。
	ImportEventArgs	匯入事件的引數。
	ImportStructureException	根據工作項目類型匯入期間，所發生的錯誤分類。
	ImportWorkItemLinkTypeException	為無效的查詢文字的錯誤分類。
	ImportWorkitemTypeException	根據工作項目類型匯入期間，所發生的錯誤分類。
	InternalAdmin
	InternalDatastoreException	錯誤的例外狀況在內部資料存放區。
	InternalFields	定義所有內部欄位參考名稱。
	InvalidFieldValueException	為所發生的錯誤分類，在嘗試重新命名欄位時寫入無效的值。
	InvalidProjectException	已過時。無效的專案錯誤的類別。
	InvalidQueryTextException	為無效的查詢文字的錯誤分類。
	InvalidTreeNodeException	無效的樹狀節點錯誤的類別。
	ItemAlreadyUpdatedOnServerException	可在伺服器錯誤已更新的工作項目分類。
	Link	說明連結的實作。
	LinkCollection	表示屬於 WorkItem 連結物件的集合。
	MetadataEventArgs	中繼資料的引數變更事件。
	Node	描述用於工作項目追蹤資料結構之的物件。
	NodeCollection	表示物件的集合。
	OMStringUtil
	PageSizeRangeException	為在頁面大小範圍的錯誤分類。
	Project	代表工作項目追蹤專案。
	ProjectCollection	表示專案的集合。
	Query	表示查詢的工作項目追蹤服務。
	QueryDefinition	表示查詢。
	QueryFolder	表示可包含 QueryDefinition和其他 QueryFolders 的 Team 專案的資料夾。
	QueryFolderContentsChangedEventArgs	QueryFolderContentsChanged 事件的事件引數。
	QueryHierarchy	表示專案中的最上層資料夾。
	QueryHierarchyException	針對工作項目中存放區的階層架構，查詢期間發生的錯誤分類。
	QueryHierarchyProvider
	QueryHierarchyRefreshData
	QueryItem	查詢資料夾和查詢所定義的基底類別。
	ReadOnlyFieldException	類別提供了可以嘗試寫入唯讀區域錯誤寫入。
	RegisteredLinkType	描述已註冊的連結類型。
	RegisteredLinkTypeCollection	有效的登錄的連結類型的集合。
	RelatedLink	連結在同一個工作項目的兩個工作項目物件跨存放區和。
	ReportingAttributes	描述欄位的報告屬性。
	RequestCancelledByUserException	為使用者錯誤取消要求的分類。
	RequestNotCancelableException	類別提供了可以嘗試移除一 noncancelable 要求錯誤。
	Revision	代表工作項目修訂狀態。
	RevisionCollection	代表工作項目的修訂記錄。
	Schemas	包含結構描述相關方法的抽象類別。
	Server	用於類別進行伺服器呼叫。
	ServerInfo	這個類別會公開 (Expose) 與伺服器的相關資訊。
	ServerRejectedChangesException	拒絕的伺服器類別變更錯誤。
	SortField	表示 WorkItem可用來排序查詢結果的Field 。
	SortFieldList	表示可由查詢排序 SortFields 的集合。
	StoredQueriesChangedEventArgs	引數或 StoredQueriesChanged 事件。
	StoredQuery	表示已儲存的查詢。
	StoredQueryCollection	表示從專案或工作項目存放區的預存查詢集合。
	SupportedFeatures	ID 清單所有已知支援的功能。
	TreeViolationException	根據工作項目類型匯入期間，所發生的錯誤分類。
	UnexpectedErrorException	報告例外狀況之錯誤條件的類別。
	UnsupportedDocumentVersionException	不支援的文件版本錯誤的類別。
	ValidationException	分類描述驗證例外狀況。
	ValuesCollection	值的集合。
	VerbatimMessageException	為含有訊息應該顯示常值的錯誤分類。
	WorkItem	表示 Team Foundation Server的工作項目。
	WorkItemAsyncEventArgs	處理非同步工作項目變更事件的類別來查詢的狀態。
	WorkItemChangeRejectedException	工作項目變更拒絕錯誤的類別。
	WorkItemCollection	表示由查詢 WorkItemStore到工作項目的集合。
	WorkItemEventArgs	工作項目事件的引數。
	WorkItemFieldData
	WorkItemLink	連結都是相同的 WorkItemStore的 WorkItems。
	WorkItemLinkCollection	表示 WorkItemLinks. 的集合。
	WorkItemLinkData
	WorkItemLinkEventArgs	工作項目連結事件的引數。
	WorkItemLinkType	表示 WorkItemLink的特定型別。
	WorkItemLinkTypeCollection	表示 WorkItemLinkType 物件的集合。
	WorkItemLinkTypeEnd	表示 WorkItemLinkType的端點。
	WorkItemLinkTypeEndCollection	表示 WorkItemLinkTypeEnd 物件的集合。
	WorkItemLinkValidationException	根據工作項目連結的驗證期間發生的錯誤分類。
	WorkItemOperationError	表示作業的錯誤會出現在工作項目的。
	WorkItemStore	表示正在追蹤 Team Foundation Server執行之伺服器的工作項目用戶端連接。
	WorkItemStoreDiagnostics	執行工作項目連結服務的診斷方法。
	WorkItemSyncData
	WorkItemType	表示 WorkItem的特定型別。
	WorkItemTypeCollection	表示 WorkItemType 物件的集合。
	WorkItemTypeDeniedOrNotExistException	分類描述拒絕存取則為工作項目類型不存在例外狀況。

結構

	結構	說明
	FieldIndexData	欄位索引資料的資料結構。
	WorkItem.EditActionInfo
	WorkItem.EditActionSet
	WorkItemFieldData.FieldInfo
	WorkItemFieldData.FieldUpdate
	WorkItemLinkInfo	結構表示 WorkItemLink 查詢結果。
	WorkItemLinkValidationException.WorkItemLinkInfo	說明工作項目連結資訊。

委派

	委派	說明
	ImportEventHandler	匯入的事件處理常式。
	MetadataChangeEventHandler	中繼資料變更的事件處理常式。
	QueryFolderContentsChangedEventHandler	ContentsChanged 和 ChangesCommitted 事件的事件處理常式委派。
	StoredQueriesEventHandler	預存查詢的事件處理常式。
	WorkItemAsyncEventHandler	這個事件處理常式來接聽對查詢的非同步狀態的變更。
	WorkItemFieldChangeEventHandler	所引發之事件的事件處理常式委派，或是變更欄位。
	WorkItemPreSaveEventHandler

列舉

	列舉型別	說明
	BaseLinkType	描述的連結類型。
	CancelableActionState	描述一次取消動作的狀態。
	CoreField	指定 WorkItem 欄位的型別。
	FieldStatus	描述欄位的狀態。
	FieldType	描述 Field的資料型別。
	FieldUsages	描述 FieldDefinition 套用物件之物件的型別。
	ImportSeverity	描述事件的嚴重性。
	ImportStructureException.Type	描述例外狀況的類型。
	ImportWorkItemLinkTypeException.Type	進一步指定 WorkItemLinkTypeException 類型。
	ImportWorkitemTypeException.Type	WorkitemType 例外狀況的其他類別。
	LinkAction	描述如何修改集合。
	MetadataChangeTypes	描述所有可能的中繼資料變更類型。
	Node.TreeType	描述樹狀類型 (區域或反覆項目)。
	PageSizes	描述用於查詢支援，並讀取批次的頁面大小。
	QueryFolderAction	表示所發生的資料夾中的某個項目的變更類型。
	QueryHierarchyException.Type	進一步分類 QueryHierarchyException。
	QueryItemPermissions	查詢項目的使用權限的位元遮罩。
	QueryScope	描述查詢範圍。
	QueryType	描述查詢的型別。
	ReportingType	描述欄位的報告類型。
	SaveFlags	描述儲存旗標。
	SchemaType	描述 XML 文件的結構描述。
	SortType	描述 SortField 排序順序。
	StoredQueriesAction	描述在預存查詢集合執行的動作。
	StringDataLengths	描述可能會儲存至資料庫的字串值的最大長度。
	TargetSet	指定目標連結集合。
	UserDisplayMode	指定使用者帳戶的顯示模式。
	WorkItem.EditAction
	WorkItem.EditActionFlags
	WorkItemCopyFlags	旗標會指定選擇性工作項目資料應該複製。
	WorkItemFieldData.FieldFlags
	WorkItemLinkType.Topology	描述 WorkItemLinkType容許拓撲類型。
	WorkItemLinkValidationException.Action	描述例外狀況的動作。
	WorkItemLinkValidationException.Type	描述例外狀況的類型。
	WorkItemStoreFlags	列舉型別用來判斷工作項目和其他行為

請參閱

參考

其他資源

擴充 Team Foundation 的功能