mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
6bb0408582
* reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. * updates interfaces and implementations for id naming * updates reactive to match sync SDKs
91 lines
4.4 KiB
C#
91 lines
4.4 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <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 IIssueReactionsClient
|
|
{
|
|
/// <summary>
|
|
/// Get all 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="issueNumber">The issue number</param>
|
|
Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int issueNumber);
|
|
|
|
/// <summary>
|
|
/// Get all 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="issueNumber">The issue number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int issueNumber, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Get all 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="issueNumber">The issue number</param>
|
|
Task<IReadOnlyList<Reaction>> GetAll(long repositoryId, int issueNumber);
|
|
|
|
/// <summary>
|
|
/// Get all 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="issueNumber">The issue number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Reaction>> GetAll(long repositoryId, int issueNumber, 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="issueNumber">The issue number</param>
|
|
/// <param name="reaction">The reaction to create</param>
|
|
Task<Reaction> Create(string owner, string name, int issueNumber, 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="issueNumber">The issue number</param>
|
|
/// <param name="reaction">The reaction to create</param>
|
|
Task<Reaction> Create(long repositoryId, int issueNumber, 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>
|
|
Task Delete(string owner, string name, int issueNumber, long 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>
|
|
Task Delete(long repositoryId, int issueNumber, long reactionId);
|
|
}
|
|
}
|