Interface ISearchDataProvider

Represents a search mechanism that can be activated if the user types the provider name preceded by @. The Tell Me will use it's default provider in case no @ sign is detected at the beginning of the word. In case an @ is detected it will search the providers for the corresponding provider name if none is found it will use the default one. If one is detected then it will be used to do a query on it using the words after the provider name. e.g @CustomProvider stringToSearch1 stringToSearch2

Namespace: Sdl.TellMe.ProviderApi
Assembly: Sdl.TellMe.ProviderApi.dll
Syntax
public interface ISearchDataProvider

Properties

Name

Represents a search mechanism that can be activated if the user types the provider name preceded by @. The Tell Me will use it's default provider in case no @ sign is detected at the beginning of the word. In case an @ is detected it will search the providers for the corresponding provider name if none is found it will use the default one. If one is detected then it will be used to do a query on it using the words after the provider name. e.g @CustomProvider stringToSearch1 stringToSearch2

Declaration
string Name { get; }
Property Value
Type Description
String

ProviderIcon

Represents a search mechanism that can be activated if the user types the provider name preceded by @. The Tell Me will use it's default provider in case no @ sign is detected at the beginning of the word. In case an @ is detected it will search the providers for the corresponding provider name if none is found it will use the default one. If one is detected then it will be used to do a query on it using the words after the provider name. e.g @CustomProvider stringToSearch1 stringToSearch2

Declaration
Icon ProviderIcon { get; }
Property Value
Type Description
Icon

Methods

GetProviderForQuery(String)

Called to identify if the provider can be used for the query

Declaration
IEnumerable<ISearchDataProvider> GetProviderForQuery(string query)
Parameters
Type Name Description
String query

text entry from the Tell Me UI
Returns
Type Description
IEnumerable<ISearchDataProvider>

SearchForSuggestion(String)

Executes the query

Declaration
IEnumerable<ITellMeAction> SearchForSuggestion(string query)
Parameters
Type Name Description
String query

text entry from the Tell Me UI (except the @ProviderName string)
Returns
Type Description
IEnumerable<ITellMeAction>

Extension Methods