Files
octokit.net/Octokit.Reactive/Clients/IObservableOrganizationsClient.cs
2014-02-18 10:51:58 +11:00

43 lines
1.5 KiB
C#

using System;
using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
public interface IObservableOrganizationsClient
{
/// <summary>
/// Returns a client to manage members of an organization.
/// </summary>
IObservableOrganizationMembersClient Member { get; }
/// <summary>
/// Returns a client to manage teams for an organization.
/// </summary>
IObservableTeamsClient Team { get; }
/// <summary>
/// Returns the specified organization.
/// </summary>
/// <param name="org">The login of the specified organization,</param>
/// <returns></returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get"
, Justification = "It's fine. Trust us.")]
IObservable<Organization> Get(string org);
/// <summary>
/// Returns all the organizations for the current user.
/// </summary>
/// <returns></returns>
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
Justification = "Method makes a network request")]
IObservable<Organization> GetAllForCurrent();
/// <summary>
/// Returns all the organizations for the specified user
/// </summary>
/// <param name="user">The login for the user</param>
/// <returns></returns>
IObservable<Organization> GetAll(string user);
}
}