AzureDevOpsWorkItemSettings Class

Summary

Settings for aliases handling work items.
Assembly
Cake.AzureDevOps.dll
Namespace
Cake.AzureDevOps.Boards.WorkItemTracking
Base Types
graph BT Type-->Base0["BaseAzureDevOpsProjectSettings"] click Base0 "/api/Cake.AzureDevOps/BaseAzureDevOpsProjectSettings" Base0-->Base1["BaseAzureDevOpsCollectionSettings"] click Base1 "/api/Cake.AzureDevOps/BaseAzureDevOpsCollectionSettings" Base1-->Base2["BaseAzureDevOpsCredentialsSettings"] click Base2 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base2-->Base3["Object"] Type["AzureDevOpsWorkItemSettings"] class Type type-node

Syntax

public class AzureDevOpsWorkItemSettings : BaseAzureDevOpsProjectSettings

Constructors

Name Summary
AzureDevOpsWorkItemSettings(AzureDevOpsWorkItemSettings, int) Initializes a new instance of the AzureDevOpsWorkItemSettings class based on the instance of a AzureDevOpsWorkItemSettings class.
AzureDevOpsWorkItemSettings(AzureDevOpsWorkItemSettings) Initializes a new instance of the AzureDevOpsWorkItemSettings class based on the instance of a AzureDevOpsWorkItemSettings class.
AzureDevOpsWorkItemSettings(BaseAzureDevOpsProjectSettings) Initializes a new instance of the AzureDevOpsWorkItemSettings class based on the instance of a BaseAzureDevOpsProjectSettings class.
AzureDevOpsWorkItemSettings(int, IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsWorkItemSettings class using environment variables as set by an Azure Pipelines build.
AzureDevOpsWorkItemSettings(Uri, Guid, int, IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsWorkItemSettings class.
AzureDevOpsWorkItemSettings(Uri, string, int, IAzureDevOpsCredentials) Initializes a new instance of the AzureDevOpsWorkItemSettings class.

Properties

Name Value Summary
CollectionUrl Uri
Gets the full URL of the Azure DevOps collection, eg. 
http://myserver:8080/defaultcollection
.
Credentials IAzureDevOpsCredentials
Gets the credentials used to authenticate against Azure DevOps.
ProjectGuid Guid
Gets the Guid of the project. Can be System.Guid.Empty if ProjectName is set.
ProjectName string
Gets the name of the project. Can be null if ProjectGuid is set.
ThrowExceptionIfWorkItemCouldNotBeFound bool
Gets or sets a value indicating whether an exception should be thrown if work item for WorkItemId could not be found.
WorkItemId int
Gets the ID of the work item.

Methods

Name Value Summary
UsingAzurePipelinesOAuthToken(int) AzureDevOpsWorkItemSettings
Constructs the settings object for a specific work item using the access token provided by Azure Pipelines.
static

Extension Methods

Name Value Summary
Dump<AzureDevOpsWorkItemSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AzureDevOpsWorkItemSettings>(AzureDevOpsWorkItemSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzureDevOpsWorkItemSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<AzureDevOpsWorkItemSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<AzureDevOpsWorkItemSettings>(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<AzureDevOpsWorkItemSettings>(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
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin