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

added new overloads

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-16 23:33:11 +07:00
parent 27d0077aae
commit ffb3680d99
4 changed files with 537 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
Octokit.Reactive/Clients/IObservablePullRequestReviewCommentsClient.cs
View File

@@ -3,6 +3,12 @@ using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Pull Request Review Comments API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/pulls/comments/">Review Comments API documentation</a> for more information.
/// </remarks>
public interface IObservablePullRequestReviewCommentsClient
{
/// <summary>
@@ -15,6 +21,15 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified pull request</returns>
IObservable<PullRequestReviewComment> GetAll(string owner, string name, int number);
/// <summary>
/// Gets review comments for a specified pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified pull request</returns>
IObservable<PullRequestReviewComment> GetAll(int repositoryId, int number);
/// <summary>
/// Gets review comments for a specified pull request.
/// </summary>
@@ -26,6 +41,16 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified pull request</returns>
IObservable<PullRequestReviewComment> GetAll(string owner, string name, int number, ApiOptions options);
/// <summary>
/// Gets review comments for a specified pull request.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified pull request</returns>
IObservable<PullRequestReviewComment> GetAll(int repositoryId, int number, ApiOptions options);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
@@ -35,6 +60,14 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(string owner, string name);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(int repositoryId);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
@@ -45,6 +78,15 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
@@ -55,6 +97,15 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(string owner, string name, PullRequestReviewCommentRequest request);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">The sorting <see cref="PullRequestReviewCommentRequest">parameters</see></param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(int repositoryId, PullRequestReviewCommentRequest request);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
@@ -66,6 +117,16 @@ namespace Octokit.Reactive
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(string owner, string name, PullRequestReviewCommentRequest request, ApiOptions options);
/// <summary>
/// Gets a list of the pull request review comments in a specified repository.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="request">The sorting <see cref="PullRequestReviewCommentRequest">parameters</see></param>
/// <param name="options">Options for changing the API response</param>
/// <returns>The list of <see cref="PullRequestReviewComment"/>s for the specified repository</returns>
IObservable<PullRequestReviewComment> GetAllForRepository(int repositoryId, PullRequestReviewCommentRequest request, ApiOptions options);
/// <summary>
/// Gets a single pull request review comment by number.
/// </summary>
@@ -76,6 +137,15 @@ namespace Octokit.Reactive
/// <returns>The <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> GetComment(string owner, string name, int number);
/// <summary>
/// Gets a single pull request review comment by number.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#get-a-single-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request review comment number</param>
/// <returns>The <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> GetComment(int repositoryId, int number);
/// <summary>
/// Creates a comment on a pull request review.
/// </summary>
@@ -87,6 +157,16 @@ namespace Octokit.Reactive
/// <returns>The created <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> Create(string owner, string name, int number, PullRequestReviewCommentCreate comment);
/// <summary>
/// Creates a comment on a pull request review.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#create-a-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The Pull Request number</param>
/// <param name="comment">The comment</param>
/// <returns>The created <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> Create(int repositoryId, int number, PullRequestReviewCommentCreate comment);
/// <summary>
/// Creates a comment on a pull request review as a reply to another comment.
/// </summary>
@@ -98,6 +178,16 @@ namespace Octokit.Reactive
/// <returns>The created <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> CreateReply(string owner, string name, int number, PullRequestReviewCommentReplyCreate comment);
/// <summary>
/// Creates a comment on a pull request review as a reply to another comment.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#create-a-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request number</param>
/// <param name="comment">The comment</param>
/// <returns>The created <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> CreateReply(int repositoryId, int number, PullRequestReviewCommentReplyCreate comment);
/// <summary>
/// Edits a comment on a pull request review.
/// </summary>
@@ -109,6 +199,16 @@ namespace Octokit.Reactive
/// <returns>The edited <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> Edit(string owner, string name, int number, PullRequestReviewCommentEdit comment);
/// <summary>
/// Edits a comment on a pull request review.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#edit-a-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request review comment number</param>
/// <param name="comment">The edited comment</param>
/// <returns>The edited <see cref="PullRequestReviewComment"/></returns>
IObservable<PullRequestReviewComment> Edit(int repositoryId, int number, PullRequestReviewCommentEdit comment);
/// <summary>
/// Deletes a comment on a pull request review.
/// </summary>
@@ -118,5 +218,14 @@ namespace Octokit.Reactive
/// <param name="number">The pull request review comment number</param>
/// <returns></returns>
IObservable<Unit> Delete(string owner, string name, int number);
/// <summary>
/// Deletes a comment on a pull request review.
/// </summary>
/// <remarks>http://developer.github.com/v3/pulls/comments/#delete-a-comment</remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="number">The pull request review comment number</param>
/// <returns></returns>
IObservable<Unit> Delete(int repositoryId, int number);
}
}