BaseAzureDevOpsPullRequestSettings Class

Summary

Base class for settings for aliases handling pull requests.
Assembly
Cake.AzureDevOps.dll
Namespace
Cake.AzureDevOps.Repos.PullRequest
Base Types
Derived Types
graph BT Type-->Base0["BaseAzureDevOpsCredentialsSettings"] click Base0 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base0-->Base1["Object"] Type["BaseAzureDevOpsPullRequestSettings"] class Type type-node Derived0["AzureDevOpsPullRequestSettings"]-->Type click Derived0 "/api/Cake.AzureDevOps.Repos.PullRequest/AzureDevOpsPullRequestSettings" Derived1["AzureDevOpsCreatePullRequestSettings"]-->Type click Derived1 "/api/Cake.AzureDevOps.Repos.PullRequest/AzureDevOpsCreatePullRequestSettings"

Syntax

public abstract class BaseAzureDevOpsPullRequestSettings : BaseAzureDevOpsCredentialsSettings

Constructors

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

Properties

Name Value Summary
Credentials IAzureDevOpsCredentials
Gets the credentials used to authenticate against Azure DevOps.
RepositoryUrl Uri
Gets the full URL of the Git repository, eg. 
http://myserver:8080/defaultcollection/myproject/_git/myrepository
.
SourceRefName string
Gets the branch for which the pull request is made.

Extension Methods

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