Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISearch

Search

Hierarchy

  • ISearch

Callable

  • __call(url?: string, targetInfo?: ITargetInfoProps): ISearchService

  • Creates an instance of the search library.

    Parameters

    • Optional url: string

      The optional url to execute the search against.

    • Optional targetInfo: ITargetInfoProps

      The target information.

    Returns ISearchService

Index

Properties

Methods

Properties

getQuery

getQuery: (parameters: SearchRequest) => Array<string>

Method to get the query from the search parameters.

param

The search parameters.

Type declaration

    • (parameters: SearchRequest): Array<string>

    • Parameters

      • parameters: SearchRequest

      Returns Array<string>

Methods

getAppContext

  • getAppContext(siteUrl: string): IBaseExecution

  • Method to get the app context information.

    Parameters

    • siteUrl: string

      The absolute url of the site.

    Returns IBaseExecution

getUrlById

  • getUrlById(id: string): IBaseExecution<{ GetUrlById: string }>

  • Method to get the url of a site, by its id.

    Parameters

    • id: string

      The site id.

    Returns IBaseExecution<{ GetUrlById: string }>

Generated using TypeDoc