Class UserIndexBuilder

Namespace

Dynamicweb.Security.UserManagement.Indexing

Assembly

Dynamicweb.Core.dll

The class UserIndexBuilder represents index builder for users

[AddInName("User Index Builder")]
public class UserIndexBuilder : IndexBuilderBase, IIndexBuilder, IResumable

Inheritance

object

ConfigurableAddIn

IndexBuilderBase

UserIndexBuilder

Implements

IIndexBuilder

IResumable

Inherited Members

IndexBuilderBase.Name

IndexBuilderBase.Type

IndexBuilderBase.Action

IndexBuilderBase.Settings

IndexBuilderBase.Meta

IndexBuilderBase.Extenders

IndexBuilderBase.Schema

IndexBuilderBase.Notification

IndexBuilderBase.SetValue<T>(string, T)

IndexBuilderBase.GetBoolean(string)

IndexBuilderBase.GetInt32(string)

IndexBuilderBase.GetString(string)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

DefaultSettings

Gets default settings collection

public override IDictionary<string, object> DefaultSettings { get; }

Property Value

IDictionary<string, object>

DoNotFailOnMismatchingCount

[AddInParameterGroup("User Index Builder Settings")]
[AddInParameter("DoNotFailOnMismatchingCount")]
[AddInLabel("Do not fail on mismatching user count")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "Explanation=Prevents index failure if a user has been created or deleted while the index was being built;")]
public bool DoNotFailOnMismatchingCount { get; set; }

Property Value

bool

HoursToUpdate

[AddInParameterGroup("User Index Builder Settings")]
[AddInParameter("HoursToUpdate")]
[AddInLabel("Hours to update")]
[AddInParameterEditor(typeof(NumberParameterEditor), "")]
public int HoursToUpdate { get; set; }

Property Value

int

Resume

Gets or sets a value indicating the index opened in insert mode

public bool Resume { get; set; }

Property Value

bool

SkipLoyaltyPoints

[AddInParameterGroup("User Index Builder Settings")]
[AddInParameter("SkipLoyaltyPoints")]
[AddInLabel("Skip loyalty points")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipLoyaltyPoints { get; set; }

Property Value

bool

SkipOrderlines

[AddInParameterGroup("User Index Builder Settings")]
[AddInParameter("SkipOrderlines")]
[AddInLabel("Skip orderlines")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipOrderlines { get; set; }

Property Value

bool

SkipOrders

[AddInParameterGroup("User Index Builder Settings")]
[AddInParameter("SkipOrders")]
[AddInLabel("Skip orders")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipOrders { get; set; }

Property Value

bool

SupportedActions

Gets the supported actions

public override IEnumerable<string> SupportedActions { get; }

Property Value

IEnumerable<string>

UserIds

Gets or sets a list of user ids, which will be updated in the index

public IEnumerable<int> UserIds { get; set; }

Property Value

IEnumerable<int>

Methods

Build(IIndexWriter, Tracker)

Build the index

public override void Build(IIndexWriter writer, Tracker tracker)

Parameters

writer IIndexWriter

An IIndexWriter instance

tracker Tracker

A Tracker instance

GetFields()

Defines GetFields required operation

public override IEnumerable<FieldDefinitionBase> GetFields()

Returns

IEnumerable<FieldDefinitionBase>