mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
248 lines
11 KiB
C#
248 lines
11 KiB
C#
using System;
|
|
|
|
namespace Octokit.Reactive
|
|
{
|
|
/// <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 IObservableEventsClient
|
|
{
|
|
/// <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")]
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<Activity> GetAllForRepository(int 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>
|
|
IObservable<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>
|
|
IObservable<Activity> GetAllForRepository(int 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>
|
|
IObservable<Activity> 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>
|
|
IObservable<Activity> GetAllIssuesForRepository(int 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>
|
|
IObservable<Activity> 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>
|
|
IObservable<Activity> GetAllIssuesForRepository(int 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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<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>
|
|
IObservable<Activity> GetAllForAnOrganization(string user, string organization, ApiOptions options);
|
|
}
|
|
} |