mirror of
https://github.com/zoriya/octokit.net.git
synced 2025-12-06 07:16:09 +00:00
204 lines
6.4 KiB
C#
204 lines
6.4 KiB
C#
using System.Collections.Generic;
|
|
using System.Collections.ObjectModel;
|
|
using System.Diagnostics;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
using System.Globalization;
|
|
using System.Linq;
|
|
using Octokit.Internal;
|
|
|
|
namespace Octokit
|
|
{
|
|
/// <summary>
|
|
/// Searching Users
|
|
/// </summary>
|
|
[DebuggerDisplay("{DebuggerDisplay,nq}")]
|
|
public class SearchUsersRequest : BaseSearchRequest
|
|
{
|
|
/// <summary>
|
|
/// Initializes a new instance of the <see cref="SearchUsersRequest"/> class.
|
|
/// </summary>
|
|
/// <param name="term">The search term.</param>
|
|
public SearchUsersRequest(string term) : base(term)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Optional Sort field. One of followers, repositories, or joined. If not provided (null), results are sorted by best match.
|
|
/// <remarks>https://help.github.com/articles/searching-users#sorting</remarks>
|
|
/// </summary>
|
|
public UsersSearchSort? SortField { get; set; }
|
|
|
|
/// <summary>
|
|
/// The sort field as a string.
|
|
/// </summary>
|
|
public override string Sort
|
|
{
|
|
get { return SortField.ToParameter(); }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Filter users based on the number of followers they have.
|
|
/// <remarks>https://help.github.com/articles/searching-users#followers</remarks>
|
|
/// </summary>
|
|
public Range Followers { get; set; }
|
|
|
|
/// <summary>
|
|
/// Filter users based on when they joined.
|
|
/// <remarks>https://help.github.com/articles/searching-users#created</remarks>
|
|
/// </summary>
|
|
public DateRange Created { get; set; }
|
|
|
|
/// <summary>
|
|
/// Filter users by the location indicated in their profile.
|
|
/// <remarks>https://help.github.com/articles/searching-users#location</remarks>
|
|
/// </summary>
|
|
public string Location { get; set; }
|
|
|
|
/// <summary>
|
|
/// Filters users based on the number of repositories they have.
|
|
/// <remarks>https://help.github.com/articles/searching-users#repository-count</remarks>
|
|
/// </summary>
|
|
public Range Repositories { get; set; }
|
|
|
|
/// <summary>
|
|
/// Search for users that have repositories that match a certain language.
|
|
/// <remarks>https://help.github.com/articles/searching-users#language</remarks>
|
|
/// </summary>
|
|
public Language? Language { get; set; }
|
|
|
|
/// <summary>
|
|
/// With this qualifier you can restrict the search to just personal accounts or just organization accounts.
|
|
/// <remarks>https://help.github.com/articles/searching-users#type</remarks>
|
|
/// </summary>
|
|
public AccountSearchType? AccountType { get; set; }
|
|
|
|
private IEnumerable<UserInQualifier> _inQualifier;
|
|
|
|
/// <summary>
|
|
/// Qualifies which fields are searched. With this qualifier you can restrict the search to just the username, public email, full name, or any combination of these.
|
|
/// <remarks>https://help.github.com/articles/searching-users#search-in</remarks>
|
|
/// </summary>
|
|
public IEnumerable<UserInQualifier> In
|
|
{
|
|
get
|
|
{
|
|
return _inQualifier;
|
|
}
|
|
set
|
|
{
|
|
if (value != null && value.Any())
|
|
_inQualifier = value.Distinct().ToList();
|
|
}
|
|
}
|
|
|
|
public override IReadOnlyList<string> MergedQualifiers()
|
|
{
|
|
var parameters = new List<string>();
|
|
|
|
if (AccountType != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "type:{0}", AccountType));
|
|
}
|
|
|
|
if (In != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "in:{0}", string.Join(",", In)));
|
|
}
|
|
|
|
if (Repositories != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "repos:{0}", Repositories));
|
|
}
|
|
|
|
if (Location.IsNotBlank())
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "location:{0}", Location));
|
|
}
|
|
|
|
if (Language != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "language:\"{0}\"", Language.ToParameter()));
|
|
}
|
|
|
|
if (Created != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "created:{0}", Created));
|
|
}
|
|
|
|
if (Followers != null)
|
|
{
|
|
parameters.Add(string.Format(CultureInfo.InvariantCulture, "followers:{0}", Followers));
|
|
}
|
|
|
|
return new ReadOnlyCollection<string>(parameters);
|
|
}
|
|
|
|
internal string DebuggerDisplay
|
|
{
|
|
get
|
|
{
|
|
return string.Format(CultureInfo.InvariantCulture, "Term: {0} Sort: {1}", Term, Sort);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Account Type used to filter search result
|
|
/// </summary>
|
|
public enum AccountSearchType
|
|
{
|
|
/// <summary>
|
|
/// User account
|
|
/// </summary>
|
|
[Parameter(Value = "user")]
|
|
User,
|
|
|
|
/// <summary>
|
|
/// Organization account
|
|
/// </summary>
|
|
[Parameter(Value = "org")]
|
|
Org
|
|
}
|
|
|
|
/// <summary>
|
|
/// User type to filter search results
|
|
/// </summary>
|
|
public enum UserInQualifier
|
|
{
|
|
/// <summary>
|
|
/// Search by the username
|
|
/// </summary>
|
|
[SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "Username")]
|
|
[Parameter(Value = "login")]
|
|
Username,
|
|
|
|
/// <summary>
|
|
/// Search by the user's email address
|
|
/// </summary>
|
|
[Parameter(Value = "email")]
|
|
Email,
|
|
|
|
/// <summary>
|
|
/// Search by the user's full name
|
|
/// </summary>
|
|
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Fullname")]
|
|
[Parameter(Value = "fullname")]
|
|
Fullname
|
|
}
|
|
|
|
/// <summary>
|
|
///
|
|
/// </summary>
|
|
public enum UsersSearchSort
|
|
{
|
|
[Parameter(Value = "followers")]
|
|
Followers,
|
|
|
|
[Parameter(Value = "repositories")]
|
|
Repositories,
|
|
|
|
[Parameter(Value = "joined")]
|
|
Joined
|
|
}
|
|
}
|