Files
octokit.net/Octokit.Reactive/Clients/IObservableCommitCommentReactionsClient.cs

97 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 IObservableCommitCommentReactionsClient
{
/// <summary>
/// Creates a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-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>
/// <param name="reaction">The reaction to create </param>
/// <returns></returns>
IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction);
/// <summary>
/// Creates a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment</remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="reaction">The reaction to create </param>
/// <returns></returns>
IObservable<Reaction> Create(long repositoryId, int number, NewReaction reaction);
/// <summary>
/// List reactions for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-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>
IObservable<Reaction> GetAll(string owner, string name, int number);
/// <summary>
/// List reactions for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-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>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
IObservable<Reaction> GetAll(string owner, string name, int number, ApiOptions options);
/// <summary>
/// List reactions for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment</remarks>
/// <param name="repositoryId">The owner of the repository</param>
/// <param name="number">The comment id</param>
/// <returns></returns>
IObservable<Reaction> GetAll(long repositoryId, int number);
/// <summary>
/// List reactions for a specified Commit Comment
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment</remarks>
/// <param name="repositoryId">The owner of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
IObservable<Reaction> GetAll(long repositoryId, int number, ApiOptions options);
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-a-commit-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, int commentId, int reactionId);
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/en/rest/reactions#delete-a-commit-comment-reaction</remarks>
/// <param name="repositoryId">The Id 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, int commentId, int reactionId);
}
}