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

Add ApiOption overloads to IIssuesClient and IObservableIssuesClient (#1274)

Browse Source
This commit is contained in:
Brendan Forster
2016-06-02 11:21:30 +02:00
parent 029cefe76a
commit dfebfe31b6
8 changed files with 913 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableIssuesClient.cs
+117 -22
View File
@@ -42,7 +42,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <returns></returns>
/// <returns>A signal containing the requested <see cref="Issue"/>s.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<Issue> Get(string owner, string name, int number);
@@ -55,9 +55,21 @@ namespace Octokit.Reactive
/// Issues are sorted by the create date descending.
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForCurrent();
/// <summary>
/// Gets all open issues assigned to the authenticated user across all the authenticated user’s visible
/// repositories including owned repositories, member repositories, and organization repositories.
/// </summary>
/// <param name="options">Options for changing the API response</param>
/// <remarks>
/// Issues are sorted by the create date descending.
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForCurrent(ApiOptions options);
/// <summary>
/// Gets all issues across all the authenticated user’s visible repositories including owned repositories,
/// member repositories, and organization repositories.
@@ -66,9 +78,21 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForCurrent(IssueRequest request);
/// <summary>
/// Gets all issues across all the authenticated user’s visible repositories including owned repositories,
/// member repositories, and organization repositories.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForCurrent(IssueRequest request, ApiOptions options);
/// <summary>
/// Gets all open issues assigned to the authenticated user across owned and member repositories for the
/// authenticated user.
@@ -77,9 +101,21 @@ namespace Octokit.Reactive
/// Issues are sorted by the create date descending.
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOwnedAndMemberRepositories();
/// <summary>
/// Gets all open issues assigned to the authenticated user across owned and member repositories for the
/// authenticated user.
/// </summary>
/// <param name="options">Options for changing the API response</param>
/// <remarks>
/// Issues are sorted by the create date descending.
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOwnedAndMemberRepositories(ApiOptions options);
/// <summary>
/// Gets all issues across owned and member repositories for the authenticated user.
/// </summary>
@@ -87,9 +123,20 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOwnedAndMemberRepositories(IssueRequest request);
/// <summary>
/// Gets all issues across owned and member repositories for the authenticated user.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOwnedAndMemberRepositories(IssueRequest request, ApiOptions options);
/// <summary>
/// Gets all open issues assigned to the authenticated user for a given organization for the authenticated user.
/// </summary>
@@ -97,9 +144,20 @@ namespace Octokit.Reactive
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="organization">The name of the organization</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOrganization(string organization);
/// <summary>
/// Gets all open issues assigned to the authenticated user for a given organization for the authenticated user.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="organization">The name of the organization</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOrganization(string organization, ApiOptions options);
/// <summary>
/// Gets all issues for a given organization for the authenticated user.
/// </summary>
@@ -108,9 +166,21 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOrganization(string organization, IssueRequest request);
/// <summary>
/// Gets all issues for a given organization for the authenticated user.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues
/// </remarks>
/// <param name="organization">The name of the organization</param>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForOrganization(string organization, IssueRequest request, ApiOptions options);
/// <summary>
/// Gets all open issues assigned to the authenticated user for the repository.
/// </summary>
@@ -119,9 +189,21 @@ namespace Octokit.Reactive
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForRepository(string owner, string name);
/// <summary>
/// Gets all open issues assigned to the authenticated user for the repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues-for-a-repository
/// </remarks>
/// <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>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
/// Gets issues for a repository.
/// </summary>
@@ -131,9 +213,22 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <returns></returns>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForRepository(string owner, string name, RepositoryIssueRequest request);
/// <summary>
/// Gets issues for a repository.
/// </summary>
/// <remarks>
/// http://developer.github.com/v3/issues/#list-issues-for-a-repository
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="request">Used to filter and sort the list of issues returned</param>
/// <param name="options">Options for changing the API response</param>
/// <returns>A signal containing one or more <see cref="Issue"/>s.</returns>
IObservable<Issue> GetAllForRepository(string owner, string name, RepositoryIssueRequest request, ApiOptions options);
/// <summary>
/// Creates an issue for the specified repository. Any user with pull access to a repository can create an
/// issue.
@@ -142,7 +237,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="newIssue">A <see cref="NewIssue"/> instance describing the new issue to create</param>
/// <returns></returns>
/// <returns>A signal containing the new <see cref="Issue"/>.</returns>
IObservable<Issue> Create(string owner, string name, NewIssue newIssue);
/// <summary>
@@ -155,18 +250,18 @@ namespace Octokit.Reactive
/// <param name="number">The issue number</param>
/// <param name="issueUpdate">An <see cref="IssueUpdate"/> instance describing the changes to make to the issue
/// </param>
/// <returns></returns>
/// <returns>A signal containing the updated <see cref="Issue"/>.</returns>
IObservable<Issue> Update(string owner, string name, int number, IssueUpdate issueUpdate);
/// <summary>
/// Locks an issue for the specified repository. Issue owners and users with push access can lock an issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/issues/#lock-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <returns></returns>
IObservable<Unit> Lock(string owner, string name, int number);
/// <summary>
/// Locks an issue for the specified repository. Issue owners and users with push access can lock an issue.
/// </summary>
/// <remarks>https://developer.github.com/v3/issues/#lock-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <returns>A signal indicating completion.</returns>
IObservable<Unit> Lock(string owner, string name, int number);
/// <summary>
/// Unlocks an issue for the specified repository. Issue owners and users with push access can unlock an issue.
@@ -175,7 +270,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <returns></returns>
/// <returns>A signal indicating completion.</returns>
IObservable<Unit> Unlock(string owner, string name, int number);
}
}