Interface IIndexService

Namespace

Dynamicweb.Indexing

Assembly

Dynamicweb.Indexing.dll

Defines Index Service behavior and data

public interface IIndexService

Extension Methods

IndexHelper.LoadIndex(IIndexService, string, RepositoryFileFormat)

IndexHelper.SaveIndex(IIndexService, string, IIndex, RepositoryFileFormat)

Methods

BuildIndex(string, string, string)

Builds index

void BuildIndex(string name, string instance, string build)

Parameters

name string

Index name

instance string

Instance name

build string

Build name

BuildIndex(string, string, string, IDictionary<string, string>)

Builds the index.

void BuildIndex(string name, string instance, string build, IDictionary<string, string> meta)

Parameters

name string

The name.

instance string

The instance.

build string

The build.

meta IDictionary<string, string>

The meta.

BuildIndex(string, string, string, IDictionary<string, string>, bool)

Builds the index.

void BuildIndex(string name, string instance, string build, IDictionary<string, string> meta, bool isResume)

Parameters

name string

The name.

instance string

The instance.

build string

The build.

meta IDictionary<string, string>

The meta.

isResume bool

if set to true [is resume].

BuildIndex(string, string, string, string)

Builds the index.

void BuildIndex(string repository, string item, string instance, string build)

Parameters

repository string

The repository.

item string

The item.

instance string

The instance.

build string

The build.

BuildIndex(string, string, string, string, IDictionary<string, string>)

Builds the index.

void BuildIndex(string repository, string item, string instance, string build, IDictionary<string, string> meta)

Parameters

repository string

The repository.

item string

The item.

instance string

The instance.

build string

The build.

meta IDictionary<string, string>

The meta.

BuildIndex(string, string, string, string, IDictionary<string, string>, bool)

Builds the index.

void BuildIndex(string repository, string item, string instance, string build, IDictionary<string, string> meta, bool isResume)

Parameters

repository string

The repository.

item string

The item.

instance string

The instance.

build string

The build.

meta IDictionary<string, string>

The meta.

isResume bool

if set to true [is resume].

ClearCache(string, string)

Clear a cached index scheme

void ClearCache(string repository, string item)

Parameters

repository string

Name of repository

item string

Name of item

DeleteIndex(string)

Delete all indexes in specified repository

void DeleteIndex(string repository)

Parameters

repository string

Repository Name

GetActiveBuildTasks(IIndex)

Gets active build tasks

IEnumerable<TaskInfo> GetActiveBuildTasks(IIndex index)

Parameters

index IIndex

Index instance

Returns

IEnumerable<TaskInfo>

Enumeration of TaskInfo

GetQueries<TIndexBuilder>()

Gets queries

IEnumerable<IQuery> GetQueries<TIndexBuilder>()

Returns

IEnumerable<IQuery>

Enumeration of IQuery

Type Parameters

TIndexBuilder

Type of IndexBuilder

GetQueries<TIndexBuilder>(string)

Gets queries

IEnumerable<IQuery> GetQueries<TIndexBuilder>(string repository)

Parameters

repository string

Repository

Returns

IEnumerable<IQuery>

Enumeration of IQuery

Type Parameters

TIndexBuilder

Type of IndexBuilder

LoadIndex(string)

Loads index

IIndex LoadIndex(string name)

Parameters

name string

Index name

Returns

IIndex

Index instance

LoadIndex(string, string)

Loads index

IIndex LoadIndex(string repository, string item)

Parameters

repository string

Repository name

item string

Item name

Returns

IIndex

Index instance

SaveIndex(string, IIndex)

Saves index

void SaveIndex(string name, IIndex index)

Parameters

name string

Index name

index IIndex

Index instance

SaveIndex(string, string, IIndex)

Saves index state

void SaveIndex(string repository, string item, IIndex index)

Parameters

repository string

Repository name

item string

Item name

index IIndex

Index instance