Files
octokit.net/Octokit/Clients/CommitCommentReactionsClient.cs

149 lines
7.2 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 class CommitCommentReactionsClient : ApiClient, ICommitCommentReactionsClient
{
public CommitCommentReactionsClient(IApiConnection apiConnection)
: base(apiConnection)
{
}
/// <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>
[ManualRoute("POST", "/repos/{owner}/{repo}/comments/{comment_id}/reactions")]
public Task<Reaction> Create(string owner, string name, int number, NewReaction reaction)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(reaction, nameof(reaction));
return ApiConnection.Post<Reaction>(ApiUrls.CommitCommentReactions(owner, name, number), 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 owner of the repository</param>
/// <param name="number">The comment id</param>
/// <param name="reaction">The reaction to create</param>
/// <returns></returns>
[ManualRoute("POST", "/repositories/{id}/comments/{comment_id}/reactions")]
public Task<Reaction> Create(long repositoryId, int number, NewReaction reaction)
{
Ensure.ArgumentNotNull(reaction, nameof(reaction));
return ApiConnection.Post<Reaction>(ApiUrls.CommitCommentReactions(repositoryId, number), reaction);
}
/// <summary>
/// Get all 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>
[ManualRoute("GET", "/repos/{owner}/{repo}/comments/{comment_id}/reactions")]
public Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number)
{
return GetAll(owner, name, number, ApiOptions.None);
}
/// <summary>
/// Get all 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>
[ManualRoute("GET", "/repos/{owner}/{repo}/comments/{comment_id}/reactions")]
public Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll<Reaction>(ApiUrls.CommitCommentReactions(owner, name, number), null, options);
}
/// <summary>
/// Get all 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>
[ManualRoute("GET", "/repositories/{id}/comments/{comment_id}/reactions")]
public Task<IReadOnlyList<Reaction>> GetAll(long repositoryId, int number)
{
return GetAll(repositoryId, number, ApiOptions.None);
}
/// <summary>
/// Get all 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>
[ManualRoute("GET", "/repositories/{id}/comments/{comment_id}/reactions")]
public Task<IReadOnlyList<Reaction>> GetAll(long repositoryId, int number, ApiOptions options)
{
Ensure.ArgumentNotNull(options, nameof(options));
return ApiConnection.GetAll<Reaction>(ApiUrls.CommitCommentReactions(repositoryId, number), null, options);
}
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/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>
[ManualRoute("DELETE", "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}")]
public Task Delete(string owner, string name, int commentId, int reactionId)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
return ApiConnection.Delete(ApiUrls.CommitCommentReaction(owner, name, commentId, reactionId));
}
/// <summary>
/// Deletes a reaction for a specified Commit Comment
/// </summary>
/// <remarks>https://docs.github.com/rest/reactions#delete-a-commit-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>
[ManualRoute("DELETE", "/repositories/{id}/comments/{comment_id}/reactions/{reaction_id}")]
public Task Delete(long repositoryId, int commentId, int reactionId)
{
return ApiConnection.Delete(ApiUrls.CommitCommentReaction(repositoryId, commentId, reactionId));
}
}
}