Interface IUsersSearchQuery

Represents a query used for filtering and sorting when listing or searching for users.

public interface IUsersSearchQuery

An array of unique user/person ids to get. Supplying this will ignore other query parameters.

Guid[] Ids { get; }

System.Guid[]

Gets if only the email field should be search with the SearchTerm.

bool OnlySearchEmail { get; }

Boolean

Gets if only the username field should be search with the SearchTerm.

bool OnlySearchUsername { get; }

Boolean

The text to search for in users. The search is performed on the Email, FirstName and LastName fields.

string SearchTerm { get; }

String

Gets if a search should be done or not.

bool ShouldSearch { get; }

Boolean

true if a search should be done; otherwise false.

Gets what kind of users that should be included in the search.

UserKind UserKind { get; }

UserKind