mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-05 23:06:10 +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
78 lines
3.6 KiB
C#
78 lines
3.6 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 interface IAssigneesClient
|
|
{
|
|
/// <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>
|
|
Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all the available assignees (owner + collaborators) to which issues may be assigned.
|
|
/// </summary>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
Task<IReadOnlyList<User>> GetAllForRepository(long repositoryId);
|
|
|
|
/// <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>
|
|
Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name, ApiOptions 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>
|
|
Task<IReadOnlyList<User>> GetAllForRepository(long repositoryId, ApiOptions 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>
|
|
Task<bool> CheckAssignee(string owner, string name, string assignee);
|
|
|
|
/// <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="issueNumber">The issue number</param>
|
|
/// <param name="assignees">List of names of assignees to add</param>
|
|
/// <returns></returns>
|
|
Task<Issue> AddAssignees(string owner, string name, int issueNumber, AssigneesUpdate 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="issueNumber">The issue number</param>
|
|
/// <param name="assignees">List of assignees to remove</param>
|
|
/// <returns></returns>
|
|
Task<Issue> RemoveAssignees(string owner, string name, int issueNumber, AssigneesUpdate 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>
|
|
Task<bool> CheckAssignee(long repositoryId, string assignee);
|
|
}
|
|
}
|