PullRequestDiscussionThread Class

Summary

Base class for a collection of pull request comments relating to each other.
Assembly
Cake.Issues.PullRequests.dll
Namespace
Cake.Issues.PullRequests
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IPullRequestDiscussionThread"] click Interface0 "/api/Cake.Issues.PullRequests/IPullRequestDiscussionThread" Type["PullRequestDiscussionThread"] class Type type-node

Syntax

public class PullRequestDiscussionThread : IPullRequestDiscussionThread

Constructors

Name Summary
PullRequestDiscussionThread(int, PullRequestDiscussionStatus, FilePath, IEnumerable<IPullRequestDiscussionComment>) Initializes a new instance of the PullRequestDiscussionThread class.

Properties

Name Value Summary
AffectedFileRelativePath FilePath
Gets or sets the path to the file where the message should be posted. The path needs to be relative to the repository root. Can be null if discussion is not related to a change in a file.
CommentIdentifier string
Gets or sets the value to identify the comment across multiple runs.
Comments IList<IPullRequestDiscussionComment>
Gets all the comments of this thread.
CommentSource string
Gets or sets a value used to decorate comments created by this add-in.
Id int
Gets or sets the ID of the discussion thread.
ProviderType string
Gets or sets the provider type which reported the issue. This value is used to identify the comment in subsequent runs.
Resolution PullRequestDiscussionResolution
Gets or sets the resolution of the thread if Status is Resolved.
Status PullRequestDiscussionStatus
Gets or sets if the thread is active or already fixed.

Extension Methods

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