Files
octokit.net/Octokit/Clients/ISearchClient.cs
2014-10-07 14:51:36 -02:00

45 lines
1.5 KiB
C#

using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Search API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/search/">Search API documentation</a> for more information.
/// </remarks>
public interface ISearchClient
{
/// <summary>
/// search repos
/// http://developer.github.com/v3/search/#search-repositories
/// </summary>
/// <param name="search"></param>
/// <returns>List of repos</returns>
Task<SearchRepositoryResult> SearchRepo(SearchRepositoriesRequest search);
/// <summary>
/// search users
/// http://developer.github.com/v3/search/#search-users
/// </summary>
/// <param name="search"></param>
/// <returns>List of users</returns>
Task<SearchUsersResult> SearchUsers(SearchUsersRequest search);
/// <summary>
/// search issues
/// http://developer.github.com/v3/search/#search-issues
/// </summary>
/// <param name="search"></param>
/// <returns>List of issues</returns>
Task<SearchIssuesResult> SearchIssues(SearchIssuesRequest search);
/// <summary>
/// search code
/// http://developer.github.com/v3/search/#search-code
/// </summary>
/// <param name="search"></param>
/// <returns>List of files</returns>
Task<SearchCodeResult> SearchCode(SearchCodeRequest search);
}
}