zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-06 12:03:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add repositoryId overloads to methods on I(Observable)RepositoryCommentsClient (#1344)

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-18 04:47:43 +07:00
committed by Brendan Forster
parent 637802c90a
commit 6bd1f06962
7 changed files with 986 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit/Clients/RepositoryCommentsClient.cs
+108 -14
View File
@@ -23,11 +23,10 @@ namespace Octokit
/// <summary>
/// Gets a single Repository Comment by number.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment</remarks>
public Task<CommitComment> Get(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -36,13 +35,23 @@ namespace Octokit
return ApiConnection.Get<CommitComment>(ApiUrls.CommitComment(owner, name, number));
}
/// <summary>
/// Gets a single Repository Comment by number.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment id</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment</remarks>
public Task<CommitComment> Get(int repositoryId, int number)
{
return ApiConnection.Get<CommitComment>(ApiUrls.CommitComment(repositoryId, number));
}
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -54,11 +63,20 @@ namespace Octokit
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForRepository(int repositoryId)
{
return GetAllForRepository(repositoryId, ApiOptions.None);
}
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options to change the API response</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -68,14 +86,26 @@ namespace Octokit
return ApiConnection.GetAll<CommitComment>(ApiUrls.CommitComments(owner, name), options);
}
/// <summary>
/// Gets Commit Comments for a repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options to change the API response</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
return ApiConnection.GetAll<CommitComment>(ApiUrls.CommitComments(repositoryId), options);
}
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForCommit(string owner, string name, string sha)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -88,12 +118,24 @@ namespace Octokit
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForCommit(int repositoryId, string sha)
{
Ensure.ArgumentNotNullOrEmptyString(sha, "sha");
return GetAllForCommit(repositoryId, sha, ApiOptions.None);
}
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <param name="options">Options to change the API response</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForCommit(string owner, string name, string sha, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -104,15 +146,29 @@ namespace Octokit
return ApiConnection.GetAll<CommitComment>(ApiUrls.CommitComments(owner, name, sha), options);
}
/// <summary>
/// Gets Commit Comments for a specified Commit.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha of the commit</param>
/// <param name="options">Options to change the API response</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit</remarks>
public Task<IReadOnlyList<CommitComment>> GetAllForCommit(int repositoryId, string sha, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(sha, "sha");
Ensure.ArgumentNotNull(options, "options");
return ApiConnection.GetAll<CommitComment>(ApiUrls.CommitComments(repositoryId, sha), options);
}
/// <summary>
/// Creates a new Commit Comment for a specified Commit.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#create-a-commit-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha">The sha reference of commit</param>
/// <param name="newCommitComment">The new comment to add to the commit</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#create-a-commit-comment</remarks>
public Task<CommitComment> Create(string owner, string name, string sha, NewCommitComment newCommitComment)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -123,15 +179,29 @@ namespace Octokit
return ApiConnection.Post<CommitComment>(ApiUrls.CommitComments(owner, name, sha), newCommitComment);
}
/// <summary>
/// Creates a new Commit Comment for a specified Commit.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="sha">The sha reference of commit</param>
/// <param name="newCommitComment">The new comment to add to the commit</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#create-a-commit-comment</remarks>
public Task<CommitComment> Create(int repositoryId, string sha, NewCommitComment newCommitComment)
{
Ensure.ArgumentNotNullOrEmptyString(sha, "sha");
Ensure.ArgumentNotNull(newCommitComment, "newCommitComment");
return ApiConnection.Post<CommitComment>(ApiUrls.CommitComments(repositoryId, sha), newCommitComment);
}
/// <summary>
/// Updates a specified Commit Comment.
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#update-a-commit-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment number</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#update-a-commit-comment</remarks>
public Task<CommitComment> Update(string owner, string name, int number, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -141,14 +211,27 @@ namespace Octokit
return ApiConnection.Patch<CommitComment>(ApiUrls.CommitComment(owner, name, number), new BodyWrapper(commentUpdate));
}
/// <summary>
/// Updates a specified Commit Comment.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment number</param>
/// <param name="commentUpdate">The modified comment</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#update-a-commit-comment</remarks>
public Task<CommitComment> Update(int repositoryId, int number, string commentUpdate)
{
Ensure.ArgumentNotNull(commentUpdate, "commentUpdate");
return ApiConnection.Patch<CommitComment>(ApiUrls.CommitComment(repositoryId, number), new BodyWrapper(commentUpdate));
}
/// <summary>
/// Deletes the specified Commit Comment
/// </summary>
/// <remarks>http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
/// <remarks>http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</remarks>
public Task Delete(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -156,5 +239,16 @@ namespace Octokit
return ApiConnection.Delete(ApiUrls.CommitComment(owner, name, number));
}
/// <summary>
/// Deletes the specified Commit Comment
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The comment id</param>
/// <remarks>http://developer.github.com/v3/repos/comments/#delete-a-commit-comment</remarks>
public Task Delete(int repositoryId, int number)
{
return ApiConnection.Delete(ApiUrls.CommitComment(repositoryId, number));
}
}
}