Skip to content

Commit

Permalink
Add ApiOptions overloads to methods on I(Observable)StarredClient (#1336
Browse files Browse the repository at this point in the history 
)
  • Loading branch information
@alexander-efremov @shiftkey
alexander-efremov authored and shiftkey committed Jun 2, 2016
1 parent dfebfe3 commit 85a87da
Show file tree
Hide file tree
Showing 8 changed files with 2,091 additions and 56 deletions.
105 changes: 105 additions & 0 deletions Octokit.Reactive/Clients/IObservableStarredClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ public interface IObservableStarredClient
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>s starring the passed repository</returns>
IObservable<User> GetAllStargazers(string owner, string name);

/// <summary>
/// Retrieves all of the stargazers for the passed repository
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name 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{User}"/> of <see cref="User"/>s starring the passed repository</returns>
IObservable<User> GetAllStargazers(string owner, string name, ApiOptions options);

/// <summary>
/// Retrieves all of the stargazers for the passed repository with star creation timestamps.
/// </summary>
Expand All @@ -22,6 +32,16 @@ public interface IObservableStarredClient
/// <returns>A <see cref="IObservable{UserStar}"/> of <see cref="User"/>s starring the passed repository with star creation timestamps.</returns>
IObservable<UserStar> GetAllStargazersWithTimestamps(string owner, string name);

/// <summary>
/// Retrieves all of the stargazers for the passed repository with star creation timestamps.
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name 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{UserStar}"/> of <see cref="User"/>s starring the passed repository with star creation timestamps.</returns>
IObservable<UserStar> GetAllStargazersWithTimestamps(string owner, string name, ApiOptions options);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user
/// </summary>
Expand All @@ -30,6 +50,15 @@ public interface IObservableStarredClient
/// A <see cref="IObservable{Repository}"/> of <see cref="Repository"/>(ies) starred by the current user
/// </returns>
IObservable<Repository> GetAllForCurrent();

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user
/// </summary>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated</exception>
/// <returns>
/// A <see cref="IObservable{Repository}"/> of <see cref="Repository"/>(ies) starred by the current user
/// </returns>
IObservable<Repository> GetAllForCurrent(ApiOptions options);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user with star creation timestamps.
Expand All @@ -39,6 +68,15 @@ public interface IObservableStarredClient
/// A <see cref="IObservable{RepoStar}"/> of <see cref="Repository"/>(ies) starred by the current authenticated user with star creation timestamps.
/// </returns>
IObservable<RepositoryStar> GetAllForCurrentWithTimestamps();

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user with star creation timestamps.
/// </summary>
/// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
/// <returns>
/// A <see cref="IObservable{RepoStar}"/> of <see cref="Repository"/>(ies) starred by the current authenticated user with star creation timestamps.
/// </returns>
IObservable<RepositoryStar> GetAllForCurrentWithTimestamps(ApiOptions options);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user
Expand All @@ -51,6 +89,18 @@ public interface IObservableStarredClient
/// </returns>
IObservable<Repository> GetAllForCurrent(StarredRequest request);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user
/// </summary>
/// <param name="request">Star-specific request parameters that sort the results</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{Repository}"/> of <see cref="Repository"/>(ies) starred by the current user,
/// sorted according to the passed request parameters
/// </returns>
IObservable<Repository> GetAllForCurrent(StarredRequest request, ApiOptions options);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user with star creation timestamps.
/// </summary>
Expand All @@ -62,6 +112,18 @@ public interface IObservableStarredClient
/// </returns>
IObservable<RepositoryStar> GetAllForCurrentWithTimestamps(StarredRequest request);

/// <summary>
/// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user with star creation timestamps.
/// </summary>
/// <param name="request">Star-specific request parameters that sort the results</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{RepoStar}"/> of <see cref="Repository"/>(ies) starred by the current user,
/// sorted according to the passed request parameters and with star creation timestamps.
/// </returns>
IObservable<RepositoryStar> GetAllForCurrentWithTimestamps(StarredRequest request, ApiOptions options);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user
/// </summary>
Expand All @@ -70,6 +132,15 @@ public interface IObservableStarredClient
/// <returns>A <see cref="IObservable{Repository}"/> starred by the specified user</returns>
IObservable<Repository> GetAllForUser(string user);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user
/// </summary>
/// <param name="user">The login of the user</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{Repository}"/> starred by the specified user</returns>
IObservable<Repository> GetAllForUser(string user, ApiOptions options);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user with star creation timestamps.
/// </summary>
Expand All @@ -80,6 +151,17 @@ public interface IObservableStarredClient
/// </returns>
IObservable<RepositoryStar> GetAllForUserWithTimestamps(string user);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user with star creation timestamps.
/// </summary>
/// <param name="user">The login of the user</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{RepoStar}"/>(ies) starred by the specified user with star creation timestamps.
/// </returns>
IObservable<RepositoryStar> GetAllForUserWithTimestamps(string user, ApiOptions options);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user
/// </summary>
Expand All @@ -89,6 +171,16 @@ public interface IObservableStarredClient
/// <returns>A <see cref="IObservable{Repository}"/> starred by the specified user</returns>
IObservable<Repository> GetAllForUser(string user, StarredRequest request);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user
/// </summary>
/// <param name="user">The login of the user</param>
/// <param name="request">Star-specific request parameters that sort the results</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{Repository}"/> starred by the specified user</returns>
IObservable<Repository> GetAllForUser(string user, StarredRequest request, ApiOptions options);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user with star creation timestamps.
/// </summary>
Expand All @@ -101,6 +193,19 @@ public interface IObservableStarredClient
/// </returns>
IObservable<RepositoryStar> GetAllForUserWithTimestamps(string user, StarredRequest request);

/// <summary>
/// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user with star creation timestamps.
/// </summary>
/// <param name="user">The login of the user</param>
/// <param name="request">Star-specific request parameters that sort the results</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{RepoStar}"/> of <see cref="Repository"/>(ies) starred by the specified user,
/// sorted according to the passed request parameters and with star creation timestamps.
/// </returns>
IObservable<RepositoryStar> GetAllForUserWithTimestamps(string user, StarredRequest request, ApiOptions options);

/// <summary>
/// Check if a repository is starred by the current authenticated user
/// </summary>
Expand Down
Loading

0 comments on commit 85a87da

Please sign in to comment.