AzureDevOpsPullRequestSystemSettings Class

Summary

graph BT Type-->Base0["AzureDevOpsPullRequestSettings"] click Base0 "/api/Cake.AzureDevOps.Repos.PullRequest/AzureDevOpsPullRequestSettings" Base0-->Base1["BaseAzureDevOpsPullRequestSettings"] click Base1 "/api/Cake.AzureDevOps.Repos.PullRequest/BaseAzureDevOpsPullRequestSettings" Base1-->Base2["BaseAzureDevOpsCredentialsSettings"] click Base2 "/api/Cake.AzureDevOps/BaseAzureDevOpsCredentialsSettings" Base2-->Base3["Object"] Type["AzureDevOpsPullRequestSystemSettings"] class Type type-node

Syntax

public class AzureDevOpsPullRequestSystemSettings : AzureDevOpsPullRequestSettings

Constructors

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

Properties

Name Value Summary
CheckCommitId bool
Gets or sets a value indicating whether pull request system should check if commit Id is still up to date before posting comments. Default value is true.
Credentials IAzureDevOpsCredentials
Gets the credentials used to authenticate against Azure DevOps.
ManageDiscussionThreadStatus bool
Gets or sets a value indicating whether discussion threads should automatically be resolved oder reopened. Default value is true.
PullRequestId Nullable<int>
Gets the ID of the pull request.
ReportIssuesNotRelatedToAFile bool
Gets or sets a value indicating whether issues not related to a file should be posted as comments or not. Default value is false.
RepositoryUrl Uri
Gets the full URL of the Git repository, eg.
http://myserver:8080/defaultcollection/myproject/_git/myrepository
.
SourceBranch string
Gets the branch for which the pull request is made.
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<AzureDevOpsPullRequestSystemSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<AzureDevOpsPullRequestSystemSettings>(AzureDevOpsPullRequestSystemSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzureDevOpsPullRequestSystemSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<AzureDevOpsPullRequestSystemSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<AzureDevOpsPullRequestSystemSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AzureDevOpsPullRequestSystemSettings>(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