AzureDevOpsWorkItem Class

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

Name Value Summary
Dump<AzureDevOpsWorkItem>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AzureDevOpsWorkItem>(AzureDevOpsWorkItem[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzureDevOpsWorkItem>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AzureDevOpsWorkItem>(string) void
Requires the Cake.Issues addin
ThrowIfNull<AzureDevOpsWorkItem>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AzureDevOpsWorkItem>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin