AzureDevOpsPullRequestSettings Class

Summary

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

Syntax

public class AzureDevOpsPullRequestSettings : BaseAzureDevOpsPullRequestSettings

Constructors

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

Properties

Name Value Summary
Credentials IAzureDevOpsCredentials
Gets the credentials used to authenticate against Azure DevOps.
PullRequestId Nullable<int>
Gets the ID of the pull request.
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.
ThrowExceptionIfPullRequestCouldNotBeFound bool
Gets or sets a value indicating whether an exception should be thrown if pull request for SourceRefName or PullRequestId could not be found.

Methods

Name Value Summary
UsingAzurePipelinesOAuthToken() AzureDevOpsPullRequestSettings
Constructs the settings object using the access token provided by Azure Pipelines.
static
UsingAzurePipelinesOAuthToken(bool) AzureDevOpsPullRequestSettings
Constructs the settings object using the access token provided by Azure Pipelines.
static

Extension Methods

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