Files
octokit.net/Octokit.Reactive/Clients/ObservableAssigneesClient.cs
Alexander Efremov 763ee76378 modified XML docs
2016-06-12 12:53:52 +07:00

109 lines
5.0 KiB
C#

using System;
using System.Reactive.Threading.Tasks;
using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
/// <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 ObservableAssigneesClient : IObservableAssigneesClient
{
readonly IAssigneesClient _client;
readonly IConnection _connection;
public ObservableAssigneesClient(IGitHubClient client)
{
Ensure.ArgumentNotNull(client, "client");
_client = client.Issue.Assignee;
_connection = client.Connection;
}
/// <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>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "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>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(int 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 behaviour.</param>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNull(options, "options");
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Assignees(owner, name), 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 behaviour.</param>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
return _connection.GetAndFlattenAllPages<User>(ApiUrls.Assignees(repositoryId), 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>
/// <returns>A <see cref="IObservable{Bool}"/> of <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
public IObservable<bool> CheckAssignee(string owner, string name, string assignee)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Ensure.ArgumentNotNullOrEmptyString(name, "name");
Ensure.ArgumentNotNullOrEmptyString(assignee, "assignee");
return _client.CheckAssignee(owner, name, assignee).ToObservable();
}
/// <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>
/// <returns>A <see cref="IObservable{Bool}"/> of <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
public IObservable<bool> CheckAssignee(int repositoryId, string assignee)
{
Ensure.ArgumentNotNullOrEmptyString(assignee, "assignee");
return _client.CheckAssignee(repositoryId, assignee).ToObservable();
}
}
}