mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-02 02:45:32 +00:00
Ryan Gribble
3c818934b8
* 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
250 lines
12 KiB
C#
250 lines
12 KiB
C#
using System.Collections.Generic;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// A client for GitHub's Activity Events API.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// See the <a href="http://developer.github.com/v3/activity/events/">Activity Events API documentation</a> for more information
|
|
/// </remarks>
|
|
public interface IEventsClient
|
|
{
|
|
/// <summary>
|
|
/// Gets all the public events
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events
|
|
/// </remarks>
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
|
|
Task<IReadOnlyList<Activity>> GetAll();
|
|
|
|
/// <summary>
|
|
/// Gets all the public events
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events
|
|
/// </remarks>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
/// <returns>All the public <see cref="Activity"/>s for the particular user.</returns>
|
|
Task<IReadOnlyList<Activity>> GetAll(ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-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>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepository(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the issue events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
Task<IReadOnlyList<IssueEvent>> GetAllIssuesForRepository(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all the issue events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
Task<IReadOnlyList<IssueEvent>> GetAllIssuesForRepository(long repositoryId);
|
|
|
|
/// <summary>
|
|
/// Gets all the issue events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-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>
|
|
Task<IReadOnlyList<IssueEvent>> GetAllIssuesForRepository(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the issue events for a given repository
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
|
|
/// </remarks>
|
|
/// <param name="repositoryId">The Id of the repository</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<IssueEvent>> GetAllIssuesForRepository(long repositoryId, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository network
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
|
|
/// </remarks>
|
|
/// <param name="owner">The owner of the repository</param>
|
|
/// <param name="name">The name of the repository</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepositoryNetwork(string owner, string name);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given repository network
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
|
|
/// </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>
|
|
Task<IReadOnlyList<Activity>> GetAllForRepositoryNetwork(string owner, string name, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given organization
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
|
|
/// </remarks>
|
|
/// <param name="organization">The name of the organization</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForOrganization(string organization);
|
|
|
|
/// <summary>
|
|
/// Gets all the events for a given organization
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
|
|
/// </remarks>
|
|
/// <param name="organization">The name of the organization</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForOrganization(string organization, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been received by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserReceived(string user);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been received by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserReceived(string user, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been received by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserReceivedPublic(string user);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been received by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserReceivedPublic(string user, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been performed by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserPerformed(string user);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that have been performed by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserPerformed(string user, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the public events that have been performed by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserPerformedPublic(string user);
|
|
|
|
/// <summary>
|
|
/// Gets all the public events that have been performed by a given user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllUserPerformedPublic(string user, ApiOptions options);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that are associated with an organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-for-an-organization
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="organization">The name of the organization</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForAnOrganization(string user, string organization);
|
|
|
|
/// <summary>
|
|
/// Gets all the events that are associated with an organization.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// http://developer.github.com/v3/activity/events/#list-events-for-an-organization
|
|
/// </remarks>
|
|
/// <param name="user">The login of the user</param>
|
|
/// <param name="organization">The name of the organization</param>
|
|
/// <param name="options">Options for changing the API response</param>
|
|
Task<IReadOnlyList<Activity>> GetAllForAnOrganization(string user, string organization, ApiOptions options);
|
|
}
|
|
} |