added new overloads

This commit is contained in:
aedampir@gmail.com
2016-06-10 16:08:15 +07:00
parent 4230c958f8
commit 223363a03a
4 changed files with 359 additions and 1 deletions

View File

@@ -43,6 +43,17 @@ namespace Octokit.Reactive
return GetAll(owner, name, ApiOptions.None);
}
/// <summary>
/// Gets the list of hooks defined for a repository
/// </summary>
/// <param name="repositoryId">The repository's ID</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns>
public IObservable<RepositoryHook> GetAll(int repositoryId)
{
return GetAll(repositoryId, ApiOptions.None);
}
/// <summary>
/// Gets the list of hooks defined for a repository
/// </summary>
@@ -60,6 +71,20 @@ namespace Octokit.Reactive
return _connection.GetAndFlattenAllPages<RepositoryHook>(ApiUrls.RepositoryHooks(owner, name), options);
}
/// <summary>
/// Gets the list of hooks defined for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="options">Options for changing the API response</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="IObservable{RepositoryHook}"/> of <see cref="RepositoryHook"/>s representing hooks for specified repository</returns>
public IObservable<RepositoryHook> GetAll(int repositoryId, ApiOptions options)
{
Ensure.ArgumentNotNull(options, "options");
return _connection.GetAndFlattenAllPages<RepositoryHook>(ApiUrls.RepositoryHooks(repositoryId), options);
}
/// <summary>
/// Gets a single hook by Id
/// </summary>
@@ -76,6 +101,18 @@ namespace Octokit.Reactive
return _client.Get(owner, name, hookId).ToObservable();
}
/// <summary>
/// Gets a single hook by Id
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#get-single-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing hook for specified hook id</returns>
public IObservable<RepositoryHook> Get(int repositoryId, int hookId)
{
return _client.Get(repositoryId, hookId).ToObservable();
}
/// <summary>
/// Creates a hook for a repository
/// </summary>
@@ -93,6 +130,20 @@ namespace Octokit.Reactive
return _client.Create(owner, name, hook).ToObservable();
}
/// <summary>
/// Creates a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hook">The hook's parameters</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#create-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing created hook for specified repository</returns>
public IObservable<RepositoryHook> Create(int repositoryId, NewRepositoryHook hook)
{
Ensure.ArgumentNotNull(hook, "hook");
return _client.Create(repositoryId, hook).ToObservable();
}
/// <summary>
/// Edits a hook for a repository
/// </summary>
@@ -111,6 +162,21 @@ namespace Octokit.Reactive
return _client.Edit(owner, name, hookId, hook).ToObservable();
}
/// <summary>
/// Edits a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param>
/// <param name="hook">The requested changes to an edit repository hook</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns>A <see cref="RepositoryHook"/> representing modified hook for specified repository</returns>
public IObservable<RepositoryHook> Edit(int repositoryId, int hookId, EditRepositoryHook hook)
{
Ensure.ArgumentNotNull(hook, "hook");
return _client.Edit(repositoryId, hookId, hook).ToObservable();
}
/// <summary>
/// Tests a hook for a repository
/// </summary>
@@ -129,6 +195,20 @@ namespace Octokit.Reactive
return _client.Test(owner, name, hookId).ToObservable();
}
/// <summary>
/// Tests a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#test-a-hook">API documentation</a> for more information.
/// This will trigger the hook with the latest push to the current repository if the hook is subscribed to push events. If the hook
/// is not subscribed to push events, the server will respond with 204 but no test POST will be generated.</remarks>
/// <returns></returns>
public IObservable<Unit> Test(int repositoryId, int hookId)
{
return _client.Test(repositoryId, hookId).ToObservable();
}
/// <summary>
/// This will trigger a ping event to be sent to the hook.
/// </summary>
@@ -145,6 +225,18 @@ namespace Octokit.Reactive
return _client.Ping(owner, name, hookId).ToObservable();
}
/// <summary>
/// This will trigger a ping event to be sent to the hook.
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#edit-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
public IObservable<Unit> Ping(int repositoryId, int hookId)
{
return _client.Ping(repositoryId, hookId).ToObservable();
}
/// <summary>
/// Deletes a hook for a repository
/// </summary>
@@ -160,5 +252,17 @@ namespace Octokit.Reactive
return _client.Delete(owner, name, hookId).ToObservable();
}
/// <summary>
/// Deletes a hook for a repository
/// </summary>
/// <param name="repositoryId">The repository's owner</param>
/// <param name="hookId">The repository's hook id</param>
/// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#delete-a-hook">API documentation</a> for more information.</remarks>
/// <returns></returns>
public IObservable<Unit> Delete(int repositoryId, int hookId)
{
return _client.Delete(repositoryId, hookId).ToObservable();
}
}
}
}