added overloads with repositoryId for IObservableRepoCollaboratorsClient

This commit is contained in:
aedampir@gmail.com
2016-05-19 15:07:56 +07:00
parent 18b3306b9c
commit ae6c5b7405
3 changed files with 143 additions and 0 deletions
@@ -23,6 +23,17 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
IObservable<User> GetAll(string owner, string name);
/// <summary>
/// Gets all the collaborators on a repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
/// </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="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
IObservable<User> GetAll(int repositoryId);
/// <summary>
/// Gets all the collaborators on a repository.
/// </summary>
@@ -36,6 +47,18 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
IObservable<User> GetAll(string owner, string name, ApiOptions options);
/// <summary>
/// Gets all the collaborators on a repository.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/repos/collaborators/#list">API documentation</a> for more information.
/// </remarks>
/// <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="IObservable{User}"/> of <see cref="User"/>s for the specified repository.</returns>
IObservable<User> GetAll(int repositoryId, ApiOptions options);
/// <summary>
/// Checks if a user is a collaborator on a repository.
/// </summary>
@@ -49,6 +72,18 @@ namespace Octokit.Reactive
/// <returns><see cref="bool"/>True if user is a collaborator else false</returns>
IObservable<bool> IsCollaborator(string owner, string name, string user);
/// <summary>
/// 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">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>
IObservable<bool> IsCollaborator(int repositoryId, string user);
/// <summary>
/// Adds a new collaborator to the repository.
/// </summary>
@@ -62,6 +97,18 @@ namespace Octokit.Reactive
/// <returns><see cref="Unit"/></returns>
IObservable<Unit> Add(string owner, string name, string user);
/// <summary>
/// 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">Username of the new collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Unit"/></returns>
IObservable<Unit> Add(int repositoryId, string user);
/// <summary>
/// Deletes a collaborator from the repository.
/// </summary>
@@ -74,5 +121,17 @@ namespace Octokit.Reactive
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Unit"/></returns>
IObservable<Unit> Delete(string owner, string name, string user);
/// <summary>
/// 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">Username of the removed collaborator</param>
/// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
/// <returns><see cref="Unit"/></returns>
IObservable<Unit> Delete(int repositoryId, string user);
}
}