Interface ISearchHelper

Internal Search Controller Helper Interface.

Namespace: DotNetNuke.Services.Search.Internals

Assembly: DotNetNuke.dll

Syntax

public interface ISearchHelper

Remarks

This is an Internal interface and should not be used outside of Core.

Methods

| Improve this Doc View Source

AddSearchStopWords(String, Int32, String)

Adds a search stop words.

Declaration

int AddSearchStopWords(string stopWords, int portalId, string cultureCode)

Parameters

Type	Name	Description
System.String	stopWords
System.Int32	portalId
System.String	cultureCode

Returns

Type	Description
System.Int32	The new stop-words ID, or `0` if the input was invalid.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

AddSynonymsGroup(String, Int32, String, out String)

Adds a synonyms group to system.

Declaration

int AddSynonymsGroup(string synonymsTags, int portalId, string cultureCode, out string duplicateWord)

Parameters

Type	Name	Description
System.String	synonymsTags	synonyms tags separated by comma, like this: `"dnn,dotnetnuke"`.
System.Int32	portalId
System.String	cultureCode	culture code.
System.String	duplicateWord

Returns

Type	Description
System.Int32	The new synonyms group ID, or `0` if the input was invalid.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

DeleteSearchStopWords(Int32, Int32, String)

Deletes a search stop words.

Declaration

void DeleteSearchStopWords(int stopWordsId, int portalId, string cultureCode)

Parameters

Type	Name	Description
System.Int32	stopWordsId
System.Int32	portalId
System.String	cultureCode

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

DeleteSynonymsGroup(Int32, Int32, String)

Deletes a synonyms group.

Declaration

void DeleteSynonymsGroup(int synonymsGroupId, int portalId, string cultureCode)

Parameters

Type	Name	Description
System.Int32	synonymsGroupId
System.Int32	portalId
System.String	cultureCode	culture code.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetIndexerCheckpointData(Int32, String)

Internal Search Controller Helper Interface.

Declaration

string GetIndexerCheckpointData(int scheduleId, string indexerKey)

Parameters

Type	Name	Description
System.Int32	scheduleId
System.String	indexerKey

Returns

Type	Description
System.String

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetIndexerCheckpointUtcTime(Int32, String)

Internal Search Controller Helper Interface.

Declaration

DateTime GetIndexerCheckpointUtcTime(int scheduleId, string indexerKey)

Parameters

Type	Name	Description
System.Int32	scheduleId
System.String	indexerKey

Returns

Type	Description
DateTime

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetLastSuccessfulIndexingDateTime(Int32)

Internal Search Controller Helper Interface.

Declaration

DateTime GetLastSuccessfulIndexingDateTime(int scheduleId)

Parameters

Type	Name	Description
System.Int32	scheduleId

Returns

Type	Description
DateTime

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetPortalsToReindex(DateTime)

Internal Search Controller Helper Interface.

Declaration

IEnumerable<int> GetPortalsToReindex(DateTime startDate)

Parameters

Type	Name	Description
DateTime	startDate

Returns

Type	Description
IEnumerable<System.Int32>

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchCompactFlag()

Internal Search Controller Helper Interface.

Declaration

bool GetSearchCompactFlag()

Returns

Type	Description
System.Boolean

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchMinMaxLength()

Internal Search Controller Helper Interface.

Declaration

Tuple<int, int> GetSearchMinMaxLength()

Returns

Type	Description
Tuple<System.Int32, System.Int32>

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchReindexRequestTime(Int32)

Internal Search Controller Helper Interface.

Declaration

DateTime GetSearchReindexRequestTime(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
DateTime

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchStopWords(Int32, String)

Gets a search stop words.

Declaration

SearchStopWords GetSearchStopWords(int portalId, string cultureCode)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	cultureCode

Returns

Type	Description
SearchStopWords	A SearchStopWords instance or null.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchTypeByName(String)

Gets a SearchType Item for the given name.

Declaration

SearchType GetSearchTypeByName(string searchTypeName)

Parameters

Type	Name	Description
System.String	searchTypeName

Returns

Type	Description
SearchType	A SearchType instance.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSearchTypes()

Returns a list of SearchTypes defined in the system.

Declaration

IEnumerable<SearchType> GetSearchTypes()

Returns

Type	Description
IEnumerable<SearchType>	A sequence of SearchType instances.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

GetSynonyms(Int32, String, String)

Returns a list of Synonyms for a given word. E.g. leap, hop for jump.

Declaration

IEnumerable<string> GetSynonyms(int portalId, string cultureCode, string term)

Parameters

Type	Name	Description
System.Int32	portalId	portal id.
System.String	cultureCode	culture code.
System.String	term	word for which to obtain synonyms.

Returns

Type	Description
IEnumerable<System.String>	List of synonyms.

Remarks

Synonyms must be defined in system first.

| Improve this Doc View Source

GetSynonymsGroups(Int32, String)

Returns a list of SynonymsGroup defined in the system.

Declaration

IEnumerable<SynonymsGroup> GetSynonymsGroups(int portalId, string cultureCode)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	cultureCode

Returns

Type	Description
IEnumerable<SynonymsGroup>	A sequence of SynonymsGroup instances.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

IsReindexRequested(Int32, DateTime)

Internal Search Controller Helper Interface.

Declaration

bool IsReindexRequested(int portalId, DateTime startDate)

Parameters

Type	Name	Description
System.Int32	portalId
DateTime	startDate

Returns

Type	Description
System.Boolean

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

RephraseSearchText(String, Boolean, Boolean)

Internal Search Controller Helper Interface.

Declaration

string RephraseSearchText(string searchPhrase, bool useWildCard, bool allowLeadingWildcard = false)

Parameters

Type	Name	Description
System.String	searchPhrase
System.Boolean	useWildCard
System.Boolean	allowLeadingWildcard

Returns

Type	Description
System.String

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

SetIndexerCheckpointData(Int32, String, String)

Internal Search Controller Helper Interface.

Declaration

void SetIndexerCheckpointData(int scheduleId, string indexerKey, string checkPointData)

Parameters

Type	Name	Description
System.Int32	scheduleId
System.String	indexerKey
System.String	checkPointData

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

SetIndexerCheckpointUtcTime(Int32, String, DateTime)

Internal Search Controller Helper Interface.

Declaration

void SetIndexerCheckpointUtcTime(int scheduleId, string indexerKey, DateTime lastUtcTime)

Parameters

Type	Name	Description
System.Int32	scheduleId
System.String	indexerKey
DateTime	lastUtcTime

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

SetLastSuccessfulIndexingDateTime(Int32, DateTime)

Internal Search Controller Helper Interface.

Declaration

void SetLastSuccessfulIndexingDateTime(int scheduleId, DateTime startDateLocal)

Parameters

Type	Name	Description
System.Int32	scheduleId
DateTime	startDateLocal

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

SetSearchReindexRequestTime(Boolean)

Internal Search Controller Helper Interface.

Declaration

void SetSearchReindexRequestTime(bool turnOn)

Parameters

Type	Name	Description
System.Boolean	turnOn

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

SetSearchReindexRequestTime(Int32)

Internal Search Controller Helper Interface.

Declaration

DateTime SetSearchReindexRequestTime(int portalId)

Parameters

Type	Name	Description
System.Int32	portalId

Returns

Type	Description
DateTime

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

StripTagsNoAttributes(String, Boolean)

Internal Search Controller Helper Interface.

Declaration

string StripTagsNoAttributes(string html, bool retainSpace)

Parameters

Type	Name	Description
System.String	html
System.Boolean	retainSpace

Returns

Type	Description
System.String

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

UpdateSearchStopWords(Int32, String, Int32, String)

Updates a search stop words.

Declaration

int UpdateSearchStopWords(int stopWordsId, string stopWords, int portalId, string cultureCode)

Parameters

Type	Name	Description
System.Int32	stopWordsId
System.String	stopWords
System.Int32	portalId
System.String	cultureCode

Returns

Type	Description
System.Int32	`stopWordsId`, or `0` if the input was invalid.

Remarks

This is an Internal interface and should not be used outside of Core.

| Improve this Doc View Source

UpdateSynonymsGroup(Int32, String, Int32, String, out String)

Updates a synonyms group.

Declaration

int UpdateSynonymsGroup(int synonymsGroupId, string synonymsTags, int portalId, string cultureCode, out string duplicateWord)

Parameters

Type	Name	Description
System.Int32	synonymsGroupId
System.String	synonymsTags	synonyms tags separated by comma, like this: `"dnn,dotnetnuke"`.
System.Int32	portalId
System.String	cultureCode	culture code.
System.String	duplicateWord

Returns

Type	Description
System.Int32	`synonymsGroupId` or `0` if the input was invalid.

Remarks

This is an Internal interface and should not be used outside of Core.

Extension Methods

JsonExtensionsWeb.ToJson(Object)