Files
octokit.net/Octokit.Reactive/Clients/IObservableUsersClient.cs
Peter MacNaughton 133298789f Adding IObservableUserEmailsClient and...
default implementation. Still needs delete method which is skipped
because it's a HTTP DELETE. There's currently nothing in the
ApiConnection to handle this scenario and it's a rather unorthodox thing
to support.
delete.
2014-02-08 12:48:53 -07:00

32 lines
1.2 KiB
C#

using System;
using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
public interface IObservableUsersClient
{
/// <summary>
/// Returns the user specified by the login.
/// </summary>
/// <param name="login">The login name for the user</param>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get")]
[SuppressMessage("Microsoft.Naming", "CA1726:UsePreferredTerms", MessageId = "login")]
IObservable<User> Get(string login);
/// <summary>
/// Returns a <see cref="User"/> for the current authenticated user.
/// </summary>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="User"/></returns>
IObservable<User> Current();
/// <summary>
/// Update the specified <see cref="UserUpdate"/>.
/// </summary>
/// <param name="user">The login for the user</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="User"/></returns>
IObservable<User> Update(UserUpdate user);
}
}