added new overloads

modified XML docs
This commit is contained in:
Alexander Efremov
2016-06-13 19:37:47 +07:00
parent 02c677d832
commit 8ee07dd355
4 changed files with 215 additions and 4 deletions
@@ -2,6 +2,12 @@
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Activity Events API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/events/">Activity Events API documentation</a> for more information
/// </remarks>
public interface IObservableEventsClient
{
/// <summary>
@@ -35,6 +41,16 @@ namespace Octokit.Reactive
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllForRepository(string owner, string name);
/// <summary>
/// Gets all the events for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllForRepository(int repositoryId);
/// <summary>
/// Gets all the events for a given repository
/// </summary>
@@ -47,6 +63,17 @@ namespace Octokit.Reactive
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets all the events for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Gets all the issue events for a given repository
/// </summary>
@@ -58,6 +85,16 @@ namespace Octokit.Reactive
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllIssuesForRepository(string owner, string name);
/// <summary>
/// Gets all the issue events for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllIssuesForRepository(int repositoryId);
/// <summary>
/// Gets all the issue events for a given repository
/// </summary>
@@ -70,6 +107,17 @@ namespace Octokit.Reactive
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllIssuesForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets all the issue events for a given repository
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
/// </remarks>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>All the <see cref="Activity"/>s for the particular repository.</returns>
IObservable<Activity> GetAllIssuesForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Gets all the events for a given repository network
/// </summary>