zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-04 03:16:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Synchronized XML documentation of IObservableRepoCollaboratorsClient and IRepoCollaboratorsClient

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-05-19 14:55:54 +07:00
parent 8e4a777e18
commit 3ac0ea8efa
4 changed files with 136 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit/Clients/RepoCollaboratorsClient.cs
+17 -17
View File
@@ -1,6 +1,6 @@
#if NET_45
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Threading.Tasks;
#endif
namespace Octokit
@@ -31,7 +31,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>.</returns>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>s for the specified repository.</returns>
public Task<IReadOnlyList<User>> GetAll(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -48,7 +48,7 @@ namespace Octokit
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>.</returns>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>s for the specified repository.</returns>
public Task<IReadOnlyList<User>> GetAll(int repositoryId)
{
return GetAll(repositoryId, ApiOptions.None);
@@ -64,7 +64,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>.</returns>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>s for the specified repository.</returns>
public Task<IReadOnlyList<User>> GetAll(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -83,21 +83,21 @@ namespace Octokit
/// <param name="repositoryId">The id of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>.</returns>
/// <returns>A <see cref="IReadOnlyPagedCollection{User}"/> of <see cref="User"/>s for the specified repository.</returns>
public Task<IReadOnlyList<User>> GetAll(int repositoryId, ApiOptions options)
{
return ApiConnection.GetAll<User>(ApiUrls.RepoCollaborators(repositoryId), options);
}
/// <summary>
/// Checks if a user is a collaborator on a repo
/// Checks if a user is a collaborator on a repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#get">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the prospective collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="bool"/>True if user is a collaborator else false</returns>
public async Task<bool> IsCollaborator(string owner, string name, string user)
@@ -118,13 +118,13 @@ namespace Octokit
}
/// <summary>
/// Checks if a user is a collaborator on a repo
/// Checks if a user is a collaborator on a repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#get">API documentation</a> for more information.
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the prospective collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="bool"/>True if user is a collaborator else false</returns>
public async Task<bool> IsCollaborator(int repositoryId, string user)
@@ -143,14 +143,14 @@ namespace Octokit
}
/// <summary>
/// Adds a new collaborator to the repo
/// Adds a new collaborator to the repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#add-collaborator">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the new collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Task"/></returns>
public Task Add(string owner, string name, string user)
@@ -163,13 +163,13 @@ namespace Octokit
}
/// <summary>
/// Adds a new collaborator to the repo
/// Adds a new collaborator to the repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#add-collaborator">API documentation</a> for more information.
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the new collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Task"/></returns>
public Task Add(int repositoryId, string user)
@@ -180,14 +180,14 @@ namespace Octokit
}
/// <summary>
/// Deletes a collaborator from the repo
/// Deletes a collaborator from the repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#remove-collaborator">API documentation</a> for more information.
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the removed collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Task"/></returns>
public Task Delete(string owner, string name, string user)
@@ -200,13 +200,13 @@ namespace Octokit
}
/// <summary>
/// Deletes a collaborator from the repo
/// Deletes a collaborator from the repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#remove-collaborator">API documentation</a> for more information.
/// </remarks>
/// <param name="repositoryId">The id of the repository</param>
/// <param name="user">The name of the user</param>
/// <param name="user">Username of the removed collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Task"/></returns>
public Task Delete(int repositoryId, string user)