Stub out the Organization Members API Client

This commit is contained in:
Henrik Andersson
2013-11-05 20:37:44 +10:00
parent c9d14acd61
commit 2ea66970a7
3 changed files with 233 additions and 0 deletions
+101
View File
@@ -0,0 +1,101 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Octokit.Clients
{
public interface IOrganizationMembers
{
/// <summary>
/// List all users who are members of an organization. A member is a user that
/// belongs to at least 1 team in the organization.
///
/// If the authenticated user is also an owner of this organization then both
/// concealed and public member will be returned.
///
/// If the requester is not an owner of the organization the query will be redirected
/// to the public members list.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#members-list">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <returns></returns>
Task<IReadOnlyList<User>> GetAll(string org);
/// <summary>
/// List all users who have publicized their membership of the organization.
/// </summary>
/// <remarks>http://developer.github.com/v3/orgs/members/#public-members-list</remarks>
/// <param name="org"></param>
/// <returns></returns>
Task<IReadOnlyList<User>> GetPublic(string org);
/// <summary>
/// Check if a user is, publicly or privately, a member of the organization.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#check-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
Task<bool> CheckMember(string org, string user);
/// <summary>
/// Check is a user is publicly a member of the organization.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#check-public-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
Task<bool> CheckMemberPublic(string org, string user);
/// <summary>
/// Removes a user from the organization, this will also remove them from all teams
/// within the organization and they will no longer have any access to the organization's
/// repositories.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#remove-a-member">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
Task Delete(string org, string user);
/// <summary>
/// Make the authenticated user's organization membership public.
/// </summary>
/// <remarks>
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#publicize-a-users-membership" API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
Task<bool> Publicize(string org, string user);
/// <summary>
/// Make the authenticated user's organization membership private.
/// </summary>
/// <remarks>
/// This method requries authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#conceal-a-users-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
Task<bool> Conceal(string org, string user);
}
}
@@ -0,0 +1,131 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Octokit.Clients
{
public class OrganizationMembersClient : ApiClient, IOrganizationMembers
{
/// <summary>
/// Initializes a new Organization Members API client.
/// </summary>
/// <param name="apiConnection">An API connection.</param>
public OrganizationMembersClient(IApiConnection apiConnection) : base(apiConnection)
{
}
/// <summary>
/// List all users who are members of an organization. A member is a user that
/// belongs to at least 1 team in the organization.
///
/// If the authenticated user is also an owner of this organization then both
/// concealed and public member will be returned.
///
/// If the requester is not an owner of the organization the query will be redirected
/// to the public members list.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#members-list">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <returns></returns>
public Task<IReadOnlyList<User>> GetAll(string org)
{
throw new NotImplementedException();
}
/// <summary>
/// List all users who have publicized their membership of the organization.
/// </summary>
/// <remarks>http://developer.github.com/v3/orgs/members/#public-members-list</remarks>
/// <param name="org"></param>
/// <returns></returns>
public Task<IReadOnlyList<User>> GetPublic(string org)
{
throw new NotImplementedException();
}
/// <summary>
/// Check if a user is, publicly or privately, a member of the organization.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#check-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
public Task<bool> CheckMember(string org, string user)
{
throw new NotImplementedException();
}
/// <summary>
/// Check is a user is publicly a member of the organization.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#check-public-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
public Task<bool> CheckMemberPublic(string org, string user)
{
throw new NotImplementedException();
}
/// <summary>
/// Removes a user from the organization, this will also remove them from all teams
/// within the organization and they will no longer have any access to the organization's
/// repositories.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/orgs/members/#remove-a-member">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
public Task Delete(string org, string user)
{
throw new NotImplementedException();
}
/// <summary>
/// Make the authenticated user's organization membership public.
/// </summary>
/// <remarks>
/// This method requires authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#publicize-a-users-membership" API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
public Task<bool> Publicize(string org, string user)
{
throw new NotImplementedException();
}
/// <summary>
/// Make the authenticated user's organization membership private.
/// </summary>
/// <remarks>
/// This method requries authentication.
/// See the <a href="http://developer.github.com/v3/orgs/members/#conceal-a-users-membership">API documentation</a>
/// for more information.
/// </remarks>
/// <param name="org"></param>
/// <param name="user"></param>
/// <returns></returns>
public Task<bool> Conceal(string org, string user)
{
throw new NotImplementedException();
}
}
}
+1
View File
@@ -59,6 +59,7 @@
<Compile Include="Clients\ICommitStatusClient.cs" />
<Compile Include="Clients\IGitDatabaseClient.cs" />
<Compile Include="Clients\IIssueCommentsClient.cs" />
<Compile Include="Clients\IOrganizationMembers.cs" />
<Compile Include="Clients\IssueCommentsClient.cs" />
<Compile Include="Clients\IssuesClient.cs" />
<Compile Include="Clients\ITagsClient.cs" />