Show / Hide Table of Contents

Class UsersSearchQuery

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

Inheritance
Object
Query
FilterQuery
SearchQuery
UsersSearchQuery
Inherited Members
SearchQuery.ShouldSearch
FilterQuery.Filters
Query.CorrelationId
Query.TraceId
Query.Page
Query.PageSize
Query.Skip
Query.Take
Query.SortObjects
Query.Aggregates
Query.Default
Object.Equals(Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: IRM.AspNetCore.Identity
Assembly: IRM.AspNetCore.Identity.dll
Syntax
public class UsersSearchQuery : SearchQuery, Message, IUsersSearchQuery

Constructors

UsersSearchQuery()

Creates a new instance of UsersSearchQuery.

Declaration
public UsersSearchQuery()

Properties

Ids

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

Declaration
public Guid[] Ids { get; set; }
Property Value
System.Guid[]

Implements
IUsersSearchQuery.Ids

IncludeAllPersons

Gets or sets if persons that does not have any user account should be included in the search.

Declaration
public bool IncludeAllPersons { get; set; }
Property Value
Boolean

OnlySearchEmail

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

Declaration
public bool OnlySearchEmail { get; set; }
Property Value
Boolean

Implements
IUsersSearchQuery.OnlySearchEmail

OnlySearchUsername

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

Declaration
public bool OnlySearchUsername { get; set; }
Property Value
Boolean

Implements
IUsersSearchQuery.OnlySearchUsername

SearchInAllTenants

Gets or sets if the tenant should be ignored when searching in a multi-tenant configuration.

Declaration
public bool SearchInAllTenants { get; set; }
Property Value
Boolean

Remarks

Use this very carefully since it prevent the correct data isolation between tenants. This flag is only intended for the impersonation feature.

SearchTerm

The text to search for.

Declaration
public override string SearchTerm { get; set; }
Property Value
String

Overrides
SearchQuery.SearchTerm
Implements
IUsersSearchQuery.SearchTerm

UserKind

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

Declaration
public UserKind UserKind { get; set; }
Property Value
UserKind

Implements
IUsersSearchQuery.UserKind
Back to top Generated by DocFX