BaseFilteringByModifiedFilesCapability<T> Class

Summary

Capability to filter issues to only those affecting files modified in the pull request.
graph BT Type-->Base0["BasePullRequestSystemCapability<T>"] Base0-->Base1["Object"] Type-.->Interface0["ISupportFilteringByModifiedFiles"] click Interface0 "/api/Cake.Issues.PullRequests/ISupportFilteringByModifiedFiles" Type-.->Interface1["IPullRequestSystemCapability"] click Interface1 "/api/Cake.Issues.PullRequests/IPullRequestSystemCapability" Type["BaseFilteringByModifiedFilesCapability<T>"] class Type type-node

Syntax

public abstract class BaseFilteringByModifiedFilesCapability<T> : 
    BasePullRequestSystemCapability<T>, ISupportFilteringByModifiedFiles, 
    IPullRequestSystemCapability
    where T : class, IPullRequestSystem

Type Parameters

Name Description
T Type of the pull request system to which this capability belongs.

Constructors

Name Summary
BaseFilteringByModifiedFilesCapability(ICakeLog, T) Capability to filter issues to only those affecting files modified in the pull request.

Methods

Name Value Summary
GetModifiedFilesInPullRequest() IEnumerable<FilePath>
Returns a list of all files modified in a pull request.
InternalGetModifiedFilesInPullRequest() IEnumerable<FilePath>
Returns a list of all files modified in a pull request. Compared to GetModifiedFilesInPullRequest() it is safe to access Settings from this method.

Extension Methods

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