mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
6bb0408582
* reworks all number parameter names to represent what they actually are. Refactors some types to be the appropriate types based on OpenAPI and docs. * updates interfaces and implementations for id naming * updates reactive to match sync SDKs
59 lines
2.7 KiB
C#
59 lines
2.7 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <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 IIssueTimelineClient
|
|
{
|
|
/// <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="issueNumber">The issue number</param>
|
|
Task<IReadOnlyList<TimelineEventInfo>> GetAllForIssue(string owner, string repo, int issueNumber);
|
|
|
|
/// <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="issueNumber">The issue number</param>
|
|
/// <param name="options">Options for changing the API repsonse</param>
|
|
Task<IReadOnlyList<TimelineEventInfo>> GetAllForIssue(string owner, string repo, int issueNumber, 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="issueNumber">The issue number</param>
|
|
Task<IReadOnlyList<TimelineEventInfo>> GetAllForIssue(long repositoryId, int issueNumber);
|
|
|
|
/// <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="issueNumber">The issue number</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<TimelineEventInfo>> GetAllForIssue(long repositoryId, int issueNumber, ApiOptions options);
|
|
}
|
|
}
|