Files
octokit.net/Octokit.Reactive/IObservableOrganizationsClient.cs
Haacked 997e955f38 Rename to Octokit to be consistent with other API libs
GitHub is naming all of the libraries Octokit for their respective
platforms
2013-01-29 14:00:27 -08:00

34 lines
1.2 KiB
C#

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
public interface IObservableOrganizationsClient
{
/// <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<IReadOnlyCollection<Organization>> GetAllForCurrent();
/// <summary>
/// Returns all the organizations for the specified user
/// </summary>
/// <param name="user"></param>
/// <returns></returns>
IObservable<IReadOnlyCollection<Organization>> GetAll(string user);
}
}