PullRequestSystem Class

Summary

Base class for all pull request system implementations.
Assembly
Cake.Prca.dll
Namespace
Cake.Prca.PullRequests
Interfaces
Base Types
  • object
graph TD Base0["object"]-->Type Interface0["IPullRequestSystem"]-.->Type click Interface0 "/Cake.Prca.Website/api/Cake.Prca.PullRequests/IPullRequestSystem" Type["PullRequestSystem"] class Type type-node

Syntax

public abstract class PullRequestSystem : IPullRequestSystem

Constructors

Name Summary
PullRequestSystem(ICakeLog) Initializes a new instance of the PullRequestSystem class.

Properties

Name Value Summary
Log ICakeLog
Gets the Cake log context.
PrcaSettings ReportIssuesToPullRequestSettings
Gets general settings. Is set after Initialize(ReportIssuesToPullRequestSettings) was called from the core addin.

Methods

Name Value Summary
FetchActiveDiscussionThreads(string) IEnumerable<T>
Returns a list of all active discussion threads.
GetModifiedFilesInPullRequest() IEnumerable<T>
Returns a list of all files modified in a pull request.
GetPreferredCommentFormat() PrcaCommentFormat
Returns the preferred format for pull request comments.
Initialize(ReportIssuesToPullRequestSettings) bool
Initializes the code analysis provider.
InternalFetchActiveDiscussionThreads(string) IEnumerable<T>
Returns a list of all active discussion threads. Compared to FetchActiveDiscussionThreads(string) it is safe to access PrcaSettings from this method.
InternalGetModifiedFilesInPullRequest() IEnumerable<T>
Returns a list of all files modified in a pull request. Compared to GetModifiedFilesInPullRequest() it is safe to access PrcaSettings from this method.
InternalMarkThreadsAsFixed(IEnumerable<IPrcaDiscussionThread>) void
Marks a list of discussion threads as resolved. Compared to MarkThreadsAsFixed(IEnumerable<IPrcaDiscussionThread>) it is safe to access PrcaSettings from this method.
InternalPostDiscussionThreads(IEnumerable<ICodeAnalysisIssue>, string) void
Posts discussion threads for all issues which need to be posted. Compared to PostDiscussionThreads(IEnumerable<ICodeAnalysisIssue>, string) it is safe to access PrcaSettings from this method.
MarkThreadsAsFixed(IEnumerable<IPrcaDiscussionThread>) void
Marks a list of discussion threads as resolved.
PostDiscussionThreads(IEnumerable<ICodeAnalysisIssue>, string) void
Posts discussion threads for all issues which need to be posted.

Extension Methods

Name Value Summary
NotNull<PullRequestSystem>(string) void
Throws an exception if the specified parameter's value is null.
GitHub