Files
octokit.net/Octokit.Reactive/Clients/IObservableIssueTimelineClient.cs
Ryan Gribble 3c818934b8 Release v0.24 - A Sight For Sore Eyes (#1539)
* Add release notes and bump version to 0.24

* run "build FormatCode" to fix up whitespace/formatting issues

* Fix failing Ssh key tests due to "validation exception".  This key must be in use on github (under another user, most likely from these tests failing).  Changed to a new SSH key and tweaked tests to reduce chance of a key being created and not destroyed

* Assignee and Assignees cant both be specified on NewIssue.  We missed this one in the PR.  Marked Assignee as [Obsolete] and fixed tests to use Assignees

* Fix a couple of Reactions tests that were calling the wrong client methods

* Fix timeline tests - looks like the response class has changed shape a bit, it now has an Issue object in the payload and Id field isnt present (leaving Id field there in case other timeline events do use it)

* Fix some following tests that require the test user to follow more than 1 other user

* Unskip these Event tests now because apparently they work!

* add breaking changes notes

* Update ApiErrorMessageSafe to return null for empty and whitespace strings (#1540)

* return null if ApiError.Message is empty or whitespace

* Uncomment test, which now passes

* update release notes to include PR1540

* Add "Bot" AccountType, was causing a deserialization exception when running the integration test "SearchForExcludedLanguage" (#1541)

* Update to include PR1541

* add bullets to make release notes easier to read

* markup additional code mentions in notes

* Fix grammar

fields => field
2017-01-17 18:56:55 +10:00

58 lines
2.6 KiB
C#

using System;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Timeline API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/issues/timeline/">Issue Timeline API documentation</a> for more information.
/// </remarks>
public interface IObservableIssueTimelineClient
{
/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="number">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number);
/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="repo">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number, ApiOptions options);
/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int number);
/// <summary>
/// Gets all the various events that have occurred around an issue or pull request.
/// </summary>
/// <remarks>
/// https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue
/// </remarks>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
IObservable<TimelineEventInfo> GetAllForIssue(long repositoryId, int number, ApiOptions options);
}
}