mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
161 lines
7.0 KiB
C#
161 lines
7.0 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Issue Assignees API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/issues/assignees/">Issue Assignees API documentation</a> for more information.
|
|
/// </remarks>
|
|
public class AssigneesClient : ApiClient, IAssigneesClient
|
|
{
|
|
/// <summary>
|
|
/// Instantiates a new GitHub Issue Assignees API client.
|
|
/// </summary>
|
|
/// <param name="apiConnection">An API connection</param>
|
|
public AssigneesClient(IApiConnection apiConnection) : base(apiConnection)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets all the available assignees (owner + collaborators) to which issues may be assigned.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
[ManualRoute("GET", "/repos/{owner}/{repo}/assignees")]
|
|
public Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
|
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
|
|
|
return GetAllForRepository(owner, name, ApiOptions.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets all the available assignees (owner + collaborators) to which issues may be assigned.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
[ManualRoute("GET", "/repositories/{id}/assignees")]
|
|
public Task<IReadOnlyList<User>> GetAllForRepository(long repositoryId)
|
|
{
|
|
return GetAllForRepository(repositoryId, ApiOptions.None);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets all the available assignees (owner + collaborators) to which issues may be assigned.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="options">The options to change API's response.</param>
|
|
[ManualRoute("GET", "/repos/{owner}/{repo}/assignees")]
|
|
public Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name, ApiOptions options)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
|
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
|
Ensure.ArgumentNotNull(options, nameof(options));
|
|
|
|
var endpoint = ApiUrls.Assignees(owner, name);
|
|
|
|
return ApiConnection.GetAll<User>(endpoint, null, AcceptHeaders.StableVersion, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets all the available assignees (owner + collaborators) to which issues may be assigned.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">The options to change API's response.</param>
|
|
[ManualRoute("GET", "/repositories/{id}/assignees")]
|
|
public Task<IReadOnlyList<User>> GetAllForRepository(long repositoryId, ApiOptions options)
|
|
{
|
|
Ensure.ArgumentNotNull(options, nameof(options));
|
|
|
|
var endpoint = ApiUrls.Assignees(repositoryId);
|
|
|
|
return ApiConnection.GetAll<User>(endpoint, null, AcceptHeaders.StableVersion, options);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks to see if a user is an assignee for a repository.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="assignee">Username of the prospective assignee</param>
|
|
[ManualRoute("GET", "/repos/{owner}/{repo}/assignees/{username}")]
|
|
public async Task<bool> CheckAssignee(string owner, string name, string assignee)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
|
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
|
Ensure.ArgumentNotNullOrEmptyString(assignee, nameof(assignee));
|
|
|
|
try
|
|
{
|
|
var response = await Connection.Get<object>(ApiUrls.CheckAssignee(owner, name, assignee), null, null).ConfigureAwait(false);
|
|
return response.HttpResponse.IsTrue();
|
|
}
|
|
catch (NotFoundException)
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Add assignees to a specified Issue.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
/// <param name="assignees">List of names of assignees to add</param>
|
|
/// <returns></returns>
|
|
[ManualRoute("POST", "/repos/{owner}/{repo}/issues/{number}/assignees")]
|
|
public Task<Issue> AddAssignees(string owner, string name, int number, AssigneesUpdate assignees)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
|
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
|
Ensure.ArgumentNotNull(assignees, nameof(assignees));
|
|
|
|
return ApiConnection.Post<Issue>(ApiUrls.IssueAssignees(owner, name, number), assignees);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Remove assignees from a specified Issue.
|
|
/// </summary>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
/// <param name="number">The issue number</param>
|
|
/// <param name="assignees">List of assignees to remove</param>
|
|
/// <returns></returns>
|
|
[ManualRoute("DELETE", "/repos/{owner}/{repo}/issues/{number}/assignees")]
|
|
public Task<Issue> RemoveAssignees(string owner, string name, int number, AssigneesUpdate assignees)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
|
|
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
|
|
Ensure.ArgumentNotNull(assignees, nameof(assignees));
|
|
|
|
return ApiConnection.Delete<Issue>(ApiUrls.IssueAssignees(owner, name, number), assignees);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Checks to see if a user is an assignee for a repository.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="assignee">Username of the prospective assignee</param>
|
|
[ManualRoute("GET", "/repositories/{id}/assignees/{username}")]
|
|
public async Task<bool> CheckAssignee(long repositoryId, string assignee)
|
|
{
|
|
Ensure.ArgumentNotNullOrEmptyString(assignee, nameof(assignee));
|
|
|
|
try
|
|
{
|
|
var response = await Connection.Get<object>(ApiUrls.CheckAssignee(repositoryId, assignee), null, null).ConfigureAwait(false);
|
|
return response.HttpResponse.IsTrue();
|
|
}
|
|
catch (NotFoundException)
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|