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

added new overloads

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-06-16 14:35:00 +07:00
parent 4d8c07eee6
commit 537c18e043
4 changed files with 279 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableNotificationsClient.cs
+59
View File
@@ -4,6 +4,12 @@ using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Activity Notifications API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/activity/notifications/">Activity Notifications API documentation</a> for more information.
/// </remarks>
public interface IObservableNotificationsClient
{
/// <summary>
@@ -32,6 +38,14 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IObservable{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(string owner, string name);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository.</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="IObservable{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(int repositoryId);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
@@ -42,6 +56,15 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IObservable{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository.</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="IObservable{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(int repositoryId, ApiOptions options);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user.
/// </summary>
@@ -71,6 +94,15 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IReadOnlyPagedCollection{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(string owner, string name, NotificationsRequest request);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository.</param>
/// <param name="request">Specifies the parameters to filter notifications by</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(int repositoryId, NotificationsRequest request);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
@@ -82,6 +114,16 @@ namespace Octokit.Reactive
/// <returns>A <see cref="IReadOnlyPagedCollection{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(string owner, string name, NotificationsRequest request, ApiOptions options);
/// <summary>
/// Retrieves all of the <see cref="Notification"/>s for the current user specific to the specified repository.
/// </summary>
/// <param name="repositoryId">The ID of the repository.</param>
/// <param name="request">Specifies the parameters to filter notifications by</param>
/// <param name="options">Options for changing the API response</param>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>A <see cref="IReadOnlyPagedCollection{Notification}"/> of <see cref="Notification"/>.</returns>
IObservable<Notification> GetAllForRepository(int repositoryId, NotificationsRequest request, ApiOptions options);
/// <summary>
/// Marks all notifications as read.
/// </summary>
@@ -106,6 +148,14 @@ namespace Octokit.Reactive
/// <returns></returns>
IObservable<Unit> MarkAsReadForRepository(string owner, string name);
/// <summary>
/// Marks the notifications for a given repository as read.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <remarks>http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository</remarks>
/// <returns></returns>
IObservable<Unit> MarkAsReadForRepository(int repositoryId);
/// <summary>
/// Marks the notifications for a given repository as read.
/// </summary>
@@ -116,6 +166,15 @@ namespace Octokit.Reactive
/// <returns></returns>
IObservable<Unit> MarkAsReadForRepository(string owner, string name, MarkAsReadRequest markAsReadRequest);
/// <summary>
/// Marks the notifications for a given repository as read.
/// </summary>
/// <param name="repositoryId">The ID of the repository</param>
/// <param name="markAsReadRequest">The <see cref="MarkAsReadRequest"/> parameter which specifies which notifications to mark.</param>
/// <remarks>http://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository</remarks>
/// <returns></returns>
IObservable<Unit> MarkAsReadForRepository(int repositoryId, MarkAsReadRequest markAsReadRequest);
/// <summary>
/// Retrives a single <see cref="Notification"/> by Id.
/// </summary>