Files
octokit.net/Octokit/Models/Request/PullRequestReviewCommentCreate.cs
Itai Bar-Haim 4e804f61a6 Prefer using nameof(x) over literal "x" (#1781)
* updated XML docs and added some missing bits.

* prefer nameof(x) over literal "x"
2018-03-07 20:43:10 +10:00

57 lines
1.9 KiB
C#

using System.Diagnostics;
using System.Globalization;
namespace Octokit
{
/// <summary>
/// Used to create a pull request review comment.
/// </summary>
[DebuggerDisplay("{DebuggerDisplay,nq}")]
public class PullRequestReviewCommentCreate : RequestParameters
{
/// <summary>
/// Creates a comment
/// </summary>
/// <param name="body">The text of the comment</param>
/// <param name="commitId">The SHA of the commit to comment on</param>
/// <param name="path">The relative path of the file to comment on</param>
/// <param name="position">The line index in the diff to comment on</param>
public PullRequestReviewCommentCreate(string body, string commitId, string path, int position)
{
Ensure.ArgumentNotNullOrEmptyString(body, nameof(body));
Ensure.ArgumentNotNullOrEmptyString(commitId, nameof(commitId));
Ensure.ArgumentNotNullOrEmptyString(path, nameof(path));
Body = body;
CommitId = commitId;
Path = path;
Position = position;
}
/// <summary>
/// The text of the comment.
/// </summary>
public string Body { get; private set; }
/// <summary>
/// The SHA of the commit to comment on.
/// </summary>
public string CommitId { get; private set; }
/// <summary>
/// The relative path of the file to comment on.
/// </summary>
public string Path { get; private set; }
/// <summary>
/// The line index in the diff to comment on.
/// </summary>
public int Position { get; private set; }
internal string DebuggerDisplay
{
get { return string.Format(CultureInfo.InvariantCulture, "CommitId: {0}, Path: {1}, Position: {2}", CommitId, Path, Position); }
}
}
}