mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +00:00
91 lines
4.3 KiB
C#
91 lines
4.3 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 IObservableIssueReactionsClient
|
|
{
|
|
/// <summary>
|
|
/// List reactions for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
IObservable<Reaction> GetAll(string owner, string name, int number);
|
|
|
|
/// <summary>
|
|
/// List reactions for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<Reaction> GetAll(string owner, string name, int number, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// List reactions for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
IObservable<Reaction> GetAll(long repositoryId, int number);
|
|
|
|
/// <summary>
|
|
/// List reactions for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#list-reactions-for-an-issue</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
IObservable<Reaction> GetAll(long repositoryId, int number, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Creates a reaction for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
/// <param name="reaction">The reaction to create </param>
|
|
IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction);
|
|
|
|
/// <summary>
|
|
/// Creates a reaction for a specified Issue.
|
|
/// </summary>
|
|
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="number">The issue id</param>
|
|
/// <param name="reaction">The reaction to create </param>
|
|
IObservable<Reaction> Create(long repositoryId, int number, NewReaction reaction);
|
|
|
|
/// <summary>
|
|
/// Deletes a reaction for a specified Issue
|
|
/// </summary>
|
|
/// <remarks>https://docs.github.com/rest/reactions#delete-an-issue-reaction</remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="issueNumber">The issue number</param>
|
|
/// <param name="reactionId">The reaction id</param>
|
|
/// <returns></returns>
|
|
IObservable<Unit> Delete(string owner, string name, int issueNumber, int reactionId);
|
|
|
|
/// <summary>
|
|
/// Deletes a reaction for a specified Issue
|
|
/// </summary>
|
|
/// <remarks>https://docs.github.com/rest/reactions#delete-an-issue-reaction</remarks>
|
|
/// <param name="repositoryId">The owner of the repository</param>
|
|
/// <param name="issueNumber">The issue number</param>
|
|
/// <param name="reactionId">The reaction id</param>
|
|
/// <returns></returns>
|
|
IObservable<Unit> Delete(long repositoryId, int issueNumber, int reactionId);
|
|
}
|
|
}
|