Files
octokit.net/Octokit.Reactive/Clients/IObservablePullRequestReviewCommentReactionsClient.cs
Victor 6c43183837 fix: comment id model update to long instead of int
* #2927: comment id model update to long instead of int

* #2927: code review fixes (1)

* #2927: code review fixes (2)

* #2927: comment id model update to long instead of int: unit tests fix

* #2927: code review fixes

* Fixed most names of parameters

---------

Co-authored-by: Victor Vorobyev <victor@myrtle-sa.com>
Co-authored-by: Brian C. Arnold <brian.arnold@spiderrock.net>
2024-06-10 08:12:08 -05:00

91 lines
4.7 KiB
C#

using System;
using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Reactions API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/reactions/">Reactions API documentation</a> for more information.
/// </remarks>
public interface IObservablePullRequestReviewCommentReactionsClient
{
/// <summary>
/// Get all reactions for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
IObservable<Reaction> GetAll(string owner, string name, long commentId);
/// <summary>
/// Get all reactions for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(string owner, string name, long commentId, ApiOptions options);
/// <summary>
/// Get all reactions for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="commentId">The comment id</param>
IObservable<Reaction> GetAll(long repositoryId, long commentId);
/// <summary>
/// Get all reactions for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="options">Options for changing the API response</param>
IObservable<Reaction> GetAll(long repositoryId, long commentId, ApiOptions options);
/// <summary>
/// Creates a reaction for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reaction">The reaction to create</param>
IObservable<Reaction> Create(string owner, string name, long commentId, NewReaction reaction);
/// <summary>
/// Creates a reaction for a specified Pull Request Review Comment.
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment</remarks>
/// <param name="repositoryId">The owner of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reaction">The reaction to create</param>
IObservable<Reaction> Create(long repositoryId, long commentId, NewReaction reaction);
/// <summary>
/// Deletes a reaction for a specified Pull Request comment
/// </summary>
/// <remarks>https://docs.github.com/rest/reactions#delete-a-pull-request-comment-reaction</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reactionId">The reaction id</param>
/// <returns></returns>
IObservable<Unit> Delete(string owner, string name, long commentId, long reactionId);
/// <summary>
/// Deletes a reaction for a specified Pull Request comment
/// </summary>
/// <remarks>https://docs.github.com/rest/reactions#delete-a-pull-request-comment-reaction</remarks>
/// <param name="repositoryId">The owner of the repository</param>
/// <param name="commentId">The comment id</param>
/// <param name="reactionId">The reaction id</param>
/// <returns></returns>
IObservable<Unit> Delete(long repositoryId, long commentId, long reactionId);
}
}