This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.AzureDevOps.

Summary

Class to work with work item tracking.

Assembly

Cake.AzureDevOps.dll

Namespace

Cake.AzureDevOps.Boards.WorkItemTracking

Base Types

Object

graph BT Type-->Base0["Object"] Type["AzureDevOpsWorkItem"] class Type type-node

Syntax

public sealed class AzureDevOpsWorkItem

Constructors

Name	Summary
AzureDevOpsWorkItem(ICakeLog, AzureDevOpsWorkItemSettings)	Initializes a new instance of the `AzureDevOpsWorkItem` class.

Properties

Name	Value	Summary
AreaPath	string	Gets the area path of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
ChangeDate	DateTime	Gets the modify date of the work item. Returns DateTime.MinValue if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
CollectionUrl	Uri	Gets the URL for accessing the web portal of the Azure DevOps collection.
CreateDate	DateTime	Gets the create date of the work item. Returns DateTime.MinValue if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
Description	string	Gets the description of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
HasWorkItemLoaded	bool	Gets a value indicating whether a work item has been successfully loaded.
IterationPath	string	Gets the iteration path of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
ParentWorkItemId	int	Gets the id of the parent work item. Returns zero if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
Reason	string	Gets the reason of the state of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
State	string	Gets the state of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
Tags	IEnumerable<string>	Gets the tags of the work item. Returns empty list if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
TeamProject	string	Gets the team project name of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
Title	string	Gets the title of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
WorkItemId	int	Gets the ID of the work item. Returns 0 if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.
WorkItemType	string	Gets the type of the work item. Returns empty if no work item could be found and `ThrowExceptionIfWorkItemCouldNotBeFound` is set to `false`.

Methods

Name	Value	Summary
GetParentWorkItem()	AzureDevOpsWorkItem	Gets the parent work item or null of no parent exists.

Extension Methods