Direct Link

Enabling API Requests

API Request By ID

API Request Options

Securing API Requests with Messagehandlers

Using AdvantageApiAuthorization to Secure API Endpoints

Using AdvantageApiCorsPolicyProvider to Manage CORS Policies

Custom API Implementation

How Search Works

Enabling Search and Building the Index

Adding Search to Your Site

Scheduled and Command-Line Indexing

General Settings

Content, Location and Security Categories

Search Settings on Individual Pages

Controlling Which Pages Are Indexed

HTTP Headers and Cookies

Custom Words and Stop Lists

Reviewing Index Results and Logs

Controlling Indexing from Page Markup

Extending the Indexer

AdvantageCMS.Core.Admin Namespace

CMSBasePage Class

CMSBasePage.eLoggedInStatus Enumeration

AdvantageCMS.Core.Admin.BaseClasses Namespace

ActionControlBase Class

BusinessObject(T) Class

BusinessObjectBase Class

BusinessObjectClickHandler Delegate

BusinessObjectSiteSetting(T) Class

CMSBaseMasterPage Class

CMSBaseUserControl Class

CMSEngineBase Class

CMSImageDerivative Class

CSPBreadCrumb Class

DataTableColumnDefinition Class

eAdvantageImageDerivative Enumeration

eDataTableDataType Enumeration

EngineEventHandler Delegate

eProjectType Enumeration

eSearchIndexRegexMatchOption Enumeration

ListBaseControl.BusinessObjectClickHandler Delegate

LockResult Class

MenuAttributes.eMenuDropdownDirection Enumeration

NavigationPageAttributes Class

ObjectRecordKey Class

SearchIndexingOptions Class

SearchIndexSettings Class

ToolBusinessObjectClickHandler Delegate

ToolControl(T) Class

ToolControlBaseControl Class

ToolDataTableList(T) Class

ToolGridList(T) Class

ToolGridListBase Class

ToolGridListBase.ColumnDefinition Class

ToolListBase Class

ToolListBase.PageSize Structure

ToolListBaseControl Class

AdvantageCMS.Core.Admin.BaseClasses.ControlSettings Namespace

AssetControlSetting Class

EditorSetting Class

EditorSettingModule Class

eImageEditorStorage Enumeration

FileExplorerSetting Class

ImageEditorSetting Class

AdvantageCMS.Core.Admin.BusinessEntity Namespace

CMSUserDomainAttribute Class

Navigation Class

TaskDetail Class

TaskGeneral Class

AdvantageCMS.Core.Admin.Engine Namespace

CMSAdminEngine Class

CMSConfigurationEngine Class

CMSDomainEngine Class

CMSNavigationEngine Class

CMSNavigationEngine.LanguageUrl Class

CMSNavigationEngine.ResolvedNavigation Class

CMSTaskEngine Class

CMSUserEngine Class

eLockStatus Enumeration

LockStatus Class

TaskCountResult Class

AdvantageCMS.Core.Admin.Enums Namespace

eCMSActions Enumeration

eCMSChangeType Enumeration

eCMSLogType Enumeration

eDataType Enumeration

eDomainUrlType Enumeration

eNavigationStatus Enumeration

eObjectActionEvents Enumeration

ePublishStatus Enumeration

eTaskAssignState Enumeration

eTaskState Enumeration

eTaskStatus Enumeration

eTaskType Enumeration

AdvantageCMS.Core.Admin.Event Namespace

ActionArgs Class

eCMSEngine Enumeration

eCMSEngineEventStatus Enumeration

EngineEventArgs Class

ToolActionArgs Class

AdvantageCMS.Core.Admin.Extensibility Namespace

AdvantageLifecycleHandlerConfiguration Class

BusinessObjectLifecycleHandler Class

CMSHandlerResolver Class

NavigationLifecycleHandler Class

SitePageLifecycleHandler Class

AdvantageCMS.Core.Admin.Interfaces Namespace

eSyncSelection Enumeration

IFreezable Interface

IToolbarDialog Interface

IToolDataTableList Interface

IToolGridList Interface

IToolSync Interface

ToolbarArguments Class

AdvantageCMS.Core.Common Namespace

CheckInterface Class

DomainLanguageSortOrder Class

EmailUtil Class

Encryption Class

Encryption.AESEncryption Class

Encryption.RijndaelEncryption Class

mscpDomain Class

StringExtensions Class

AdvantageCMS.Core.Common.AsyncJob Namespace

InitializeAdvantage Class

InitializeSchedule Class

InitializeSearchIndex Class

AdvantageCMS.Core.Common.BaseClasses Namespace

AdvantageAdaptiveContent Class

AdvantageAdaptiveContentElement Class

AdvantageAnalytics Class

AdvantageAPIEntry Class

AdvantageAPIEntry.DomainAccess Class

AdvantageAPIEntry.eAdvantageAPIEntryPermission Enumeration

AdvantageAPIProfile Class

AdvantageAttribute Class

AdvantageAttributeArgs Class

AdvantageAttributeControl Class

AdvantageAttributeExtensions Class

AdvantageAttributeHandler Delegate

AdvantageAttributes Class

AdvantageBaseErrorPage Class

AdvantageCommonBasePage.GlobalScriptItem Class

AdvantageDocumentLink Class

AdvantageDomainAttribute Class

AdvantageErrorMessage Class

AdvantageFavicon Class

AdvantageFaviconProfile Class

AdvantageGoogleAnalytics Class

AdvantageGridSystemEntry Class

AdvantageGridSystemEntryGroup Class

AdvantageGridSystemGroup Class

AdvantageGridSystemProfile Class

AdvantageGridSystemProfileGroup Class

AdvantageHeadersMetaTagsCookies Class

AdvantageHeadersMetaTagsCookies.AdvantageContentSecurityPolicy Class

AdvantageHeadersMetaTagsCookies.AdvantageHttpHeaderItem Class

AdvantageHeadersMetaTagsCookies.AdvantageMetaTagItem Class

AdvantageHeadersMetaTagsCookies.AdvantageNonceTagMatch Class

AdvantageHeadersMetaTagsCookies.IAdvantageBaseCSPItem Interface

AdvantageImage Class

AdvantageImageElement Class

AdvantageImageElementConverter Class

AdvantageImageResizer Class

AdvantageImageResizer.AdvantageImageResizeResult Class

AdvantageLayout Class

AdvantageLayoutContainer Class

AdvantageLayoutControl Class

AdvantageLayoutPanel Class

AdvantageLayoutProfile Class

AdvantageLayoutZone Class

AdvantageMasterPageTemplate Class

AdvantageModule Class

AdvantageModuleRewrite(T) Class

AdvantageModuleRewriteBase Class

AdvantageOpenGraph Class

AdvantagePageLayout Class

AdvantagePageTemplate Class

AdvantagePreviewLinkCreatorBase Class

AdvantageRewrite Class

AdvantageSocialLink Class

AdvantageSocialLinksProfile Class

AdvantageSocialShare Class

AdvantageSocialSharesProfile Class

AdvantageSystemNotification Class

AdvantageTooltip Class

AdvantageTrialFire Class

AdvantageWelcomeLayout Class

eAdvantageAttributeArgsAction Enumeration

eAdvantageAttributeType Enumeration

eAdvantageGridSystemEntryDisplayLocation Enumeration

eAdvantageGridSystemGroupSelectionMode Enumeration

eAdvantageLinkType Enumeration

eAdvantagePageLayoutType Enumeration

eAdvantagePageRenderMode Enumeration

eAdvantageZoneStyleUsage Enumeration

eGridSystemType Enumeration

eObjectKeyCriteriaDataType Enumeration

eObjectLanguageSetting Enumeration

ExceptionRender Class

IncludeItems Class

LayoutAttributes Class

LayoutData Class

MSCPDomainLanguage Class

NonceInjectionModule Class

ObjectKeyCriteria Class

PageExtensions Class

ResizeImageFitMode Enumeration

AdvantageCMS.Core.Common.BaseClasses.Handler Namespace

AdvantageHandler Class

GenericHandlerRoute(T) Class

GenericHandlerRouteHandler(T) Class

AdvantageCMS.Core.Common.BaseClasses.Webhook Namespace

AdvantageWebhook Class

AdvantageWebhookProfile Class

AdvantageWebhookProfile.eEventForWebhook Enumeration

AdvantageCMS.Core.Common.BusinessEntity Namespace

Domain.UserGuide Class

LanguageDomain Class

PathRecord Class

AdvantageCMS.Core.Common.Engine Namespace

AdvantageConfigurationEngine Class

AdvantageEngineBase Class

AdvantageLockEngine Class

AdvantageModuleEngine Class

AdvantageUserLoginEngine Class

BusinessObjectHelper Class

AdvantageCMS.Core.Common.Enums Namespace

eAdvantageAttributeAction Enumeration

eComparison Enumeration

eDisplayLocation Enumeration

eLanguageOrientation Enumeration

eNavigationSelector Enumeration

eObjectState Enumeration

eProtocol Enumeration

AdvantageCMS.Core.Common.Extension Namespace

ControlExtension Class

DataTableExtension Class

EnumExtension Class

IEnumerableExtensions Class

JsonExtensions Class

ListExtension Class

LocalDescription Class

RequestExtension Class

TypeExtension Class

AdvantageCMS.Core.Common.Interfaces Namespace

AdvantageSocialBase Class

AdvantageCMS.Core.Common.SitemapGenerator Namespace

ArgumentHelper Class

BaseSitemapGenerator Class

BaseSitemapIndexGenerator Class

GenerateSiteMap Class

UpdateFrequency Enumeration

AdvantageCMS.Core.HttpModules Namespace

SecureSessionCookieModule Class

AdvantageCMS.Core.Keyoti Namespace

AdvantageContentFilterItem Class

AdvantageRequestItem Class

AdvantageSearchConfiguration Class

eContentFilterItemType Enumeration

eContentFilterType Enumeration

eSearchIndexMethod Enumeration

SearchConstants Class

AdvantageCMS.Core.Resource Namespace

AdvantageUrlItem Class

eAdvantageRenderLocation Enumeration

eAdvantageUrlFileType Enumeration

eAdvantageUrlLocation Enumeration

AdvantageCMS.Core.Routing Namespace

AdvantageRouteHandlerBase Class

AdvantageRouteHandlerDefault Class

AdvantageRouteHandlerRobots Class

AdvantageRouteHandlerSearchBot Class

AdvantageRouteHandlerSiteMap Class

AdvantageRouteHttpHandlerRoute Class

RegisterRoutes Class

AdvantageCMS.Core.SMTP Namespace

AdvantageSMTPClient Class

AdvantageSmtpServer Class

AdvantageSmtpServer.AdvantageMailAddress Class

AdvantageCMS.Core.Utils Namespace

AdvantageFileBrowserProviderWithImageResize Class

AdvantageRedirectRequestException Class

CookieHelper Class

DictionarySerializable(TKey, TValue) Class

DomainLanguageHelper Class

eToolHelperResult Enumeration

ExceptionUtility Class

HashtableSerailizable Class

ObjectDataContractXMLSerializer(T) Class

ObjectNetDataContractSerializer(T) Class

ObjectXMLSerializer(T) Class

Randomize Class

Randomize.ThreadSafeRandom Class

ReflectionObjectXMLSerializer Class

ReflectionType Class

ReflectionUtility Class

ResourceRegister Class

ScriptManagerHelper Class

SerializedFormat Enumeration

ToolHelper Class

ToolHelperResult Class

VType.ObjectNameResult Class

WebResourceDecryptor Class

XmlCompareUtil Class

AdvantageCMS.Core.Utils.Cache Namespace

AdvantageCacheManager Class

IAdvantageCacheContainer Interface

AdvantageCMS.Core.Utils.Cache.Containers Namespace

AdvantageCacheItem Class

eAdvantageCacheContainerType Enumeration

AdvantageCMS.Core.Utils.Parser Namespace

CssParserRule Class

AdvantageCMS.Data Namespace

ISqlProviderFactory Interface

MicrosoftSqlProviderFactory Class

Parameter Structure

SQL.Command Class

SQL.ListSource Class

SqlConnectionContext Class

SqlProviderResolver Class

SystemSqlProviderFactory Class

Transaction Class

AdvantageCMS.Data.Interfaces Namespace

IDataAccessable Interface

IDataTranslateCommand Interface

AdvantageCMS.Web.UI.Admin Namespace

AdvantageGrid Class

AdvantageGrid.AdvantageGridArgs Class

AdvantageGrid.AdvantageGridHandler Delegate

AdvantageGrid.AdvantageGridHandlerReordered Delegate

AdvantageGrid.AdvantageGridHandlerToggle Delegate

AdvantageGrid.AdvantageGridItem Class

AdvantageGrid.AdvantageGridSortArgs Class

AdvantageGrid.AdvantageGridToggleArgs Class

AdvantageGrid.GridCommandType Enumeration

GridColumnDefinition Class

GridDataKeyValue Class

AdvantageCMS.Web.UI.Admin.Selectors Namespace

AdvantageImageElementCollectionEditor Class

AdvantageSelectorConfiguration Class

AdvantageSelectorConfigurationItem Class

AdvantageSelectorDocument Class

AdvantageSelectorDocumentLink Class

AdvantageSelectorImage Class

AdvantageSelectorLink Class

eRenderMode Enumeration

AdvantageCMS.Web.UI.Admin.Tools Namespace

AdvantageDataTableToolList Class

AdvantageToolList Class

AdvantageCMS.Web.UI.Helpers Namespace

AdvantageControlException Class

AdvantageCSP.AdvantageAPI Namespace

AdvantageApiContentController Class

AdvantageApiContentController.ContentRequest Class

AdvantageApiContentController.ContentRequestSortOrder Class

ContentRequestSortOrder.eContentRequestSortOrder Enumeration

AdvantageApiContentController.KeyCriteria Class

AdvantageApiContentController.KeyDataType Enumeration

AdvantageApiContentController.UpdateRequest Class

SecureContentController Class

WebhookController Class

WebhookSender Class

AdvantageCSP.API Namespace

AdvantageApiAuthorizationAttribute Class

AdvantageApiAuthorizeBase Class

AdvantageApiControllerBase Class

AdvantageApiCorsPolicyAttribute Class

AdvantageApiCorsPolicyProviderBase Class

AdvantageApiRequest(TReturnResult) Class

AdvantageApiRequest(TReturnResult).AdvantageApiRequestResult Class

AdvantageDelegatingHandlerAuthResponse Class

AdvantageDelegatingHandlerBase Class

AdvantageSecureContentControllerHandler Class

AdvantageSecureContentControllerHandler.AdvantageAuthResponse Class

JsonString Class

WebApiConfig Class

AdvantageCSP.API.BaseClasses Namespace

EnsureSessionHandler Class

AdvantageCSP.API.Classes Namespace

OKSerialized Class

AdvantageCSP.Core.HierarchicalList Namespace

DefaultHierarchy(TItem) Class

HierarchyExtensions Class

IHierarchicalListItem(TItem) Interface

AdvantageCSP.HierarchicalModelDataSource Namespace

HierarchicalModelDataSource(T) Class

HierarchicalModelDataSourceView Class

HierarchicalModelList Class

HierarchyConverter Class

HierarchyData(T) Class

IModelWithHierarchy(T) Interface

AdvantageCSP.Keyoti.SiteIndexer Namespace

SearchIndexer Class

SearchIndexer Members

SearchIndexer Constructor

SearchIndexer Fields

SearchIndexer Methods

AssignDefaultContentCategories Method

BuildIndex Method

Dispatcher_Action Method

Dispatcher_NeedObject Method

SearchIndexer Properties

AdvantageCSP.Snipcart Namespace

SnipcartCustomProperty Class

SnipcartCustomPropertyOption Class

SnipcartItem Class

SnipcartItemValidationResult Class

AdvantageCSP.Snipcart.Engine Namespace

eItemCommand Enumeration

SnipcartEngine Class

AdvantageCSP.Snipcart.Enums Namespace

eSnipcartBoolean Enumeration

eSnipcartPaymentInterval Enumeration

eSnipcartProperties Enumeration

eSnipcartServiceType Enumeration

AdvantageCSP.Snipcart.Interfaces Namespace

ISnipcartItem Interface

SearchIndexer..::..Dispatcher_NeedObject Method

Supplies the collaborator objects the crawler asks for. Only ParserProvider is answered; every other request is left untouched so Keyoti falls back to its default.

Namespace: AdvantageCSP.Keyoti.SiteIndexer
Assembly: AdvantageCSP.Keyoti.SiteIndexer (in AdvantageCSP.Keyoti.SiteIndexer.dll)

Syntax

public void Dispatcher_NeedObject(
	Object sender,
	NeedObjectEventArgs e
)

Parameters

sender: Type: Object
The dispatcher raising the event.

e: Type: NeedObjectEventArgs
The NeedObjectEventArgs instance containing the event data.

Remarks

This event fires independently of the crawl lifecycle, whenever Keyoti needs a replaceable collaborator. e.RequiredObject arrives holding the default instance, which is why the test is a type check rather than a name check — assigning over it substitutes the implementation, leaving it alone accepts the default. Never null it out.

Returning ExtendedParserProvider here is what gives the crawl a browser session capable of rendering pages, and is the reason the provider must be disposed when the plug-in is disposed. A custom indexer that only needs the shipped parsing behaviour can hand back the same type; one that needs bespoke parsing derives from ParserProvider and returns that instead.

See Also

SearchIndexer Class

AdvantageCSP.Keyoti.SiteIndexer Namespace