View Source

Class UserFilter

Represents filter criteria for querying users.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models.Membership

Assembly: Umbraco.Core.dll

Syntax

public class UserFilter

Constructors

UserFilter()

Declaration

public UserFilter()

Properties

ExcludeUserGroups

Gets or sets the set of user group keys to exclude from the filter.

Declaration

public ISet<Guid>? ExcludeUserGroups { get; set; }

Property Value

Type	Description
ISet<Guid>

IncludeUserStates

Gets or sets the set of user states to include in the filter.

Declaration

public ISet<UserState>? IncludeUserStates { get; set; }

Property Value

Type	Description
ISet<UserState>

IncludedUserGroups

Gets or sets the set of user group keys to include in the filter.

Declaration

public ISet<Guid>? IncludedUserGroups { get; set; }

Property Value

Type	Description
ISet<Guid>

NameFilters

Gets or sets the set of name filters to apply.

Declaration

public ISet<string>? NameFilters { get; set; }

Property Value

Type	Description
ISet<string>

Methods

Merge(UserFilter)

Merges two user filters

Declaration

public UserFilter Merge(UserFilter target)

Parameters

Type	Name	Description
UserFilter	target	User filter to merge with.

Returns

Type	Description
UserFilter	A new filter containing the union of the two filters.