Class JSearchApi

Hierarchy (View Summary)

JBaseApi
- JSearchApi

Index

Constructors

constructor

new JSearchApi(jApi: JamespotUserApi): JSearchApi
Parameters
- jApi: JamespotUserApi
Returns JSearchApi
Inherited from JBaseApi.constructor
- Defined in jamespot-user-api/src/apis/base.ts:8

Properties

jApi

jApi: JamespotUserApi

network

network: Network

Methods

getAdminConfig

getAdminConfig(): Promise<ApiWrapper<any, BaseMessages>>
return the current platform json search-config object

Returns Promise<ApiWrapper<any, BaseMessages>>
- Defined in jamespot-user-api/src/apis/search/search.ts:86

getConfig

getConfig(): Promise<ApiWrapper<SearchConfig, BaseMessages>>
return a completed version of the current config, taking in account platform installed modules

Returns Promise<ApiWrapper<SearchConfig, BaseMessages>>
- Defined in jamespot-user-api/src/apis/search/search.ts:19

getLastQueries

getLastQueries(): Promise<ApiWrapper<SearchLastQuery[], BaseMessages>>
return the five last keywords typed in the searchbar by the user

Returns Promise<ApiWrapper<SearchLastQuery[], BaseMessages>>
- Defined in jamespot-user-api/src/apis/search/search.ts:77

proposition

proposition(
query: { format?: "list" | "little"; query: string },
signal?: AbortSignal,
): Promise<ApiWrapper<SearchResultCatProps[], BaseMessages>>
Return a maximum of 8 results for a given text query, classed upon config categories
Parameters
- query: { format?: "list" | "little"; query: string }
  string, words can be preceded by + and - for inclusive/exclusive search
- Optionalsignal: AbortSignal
Returns Promise<ApiWrapper<SearchResultCatProps[], BaseMessages>>
Abort Signal
to cancel the fetch
- Defined in jamespot-user-api/src/apis/search/search.ts:28

searchQuery

searchQuery(
    query: SearchQuery,
    params?: {
        formatExtension?: (
            | "comments"
            | "search"
            | "actions"
            | "attachments"
            | "contact"
            | "filebank"
            | "licenses"
            | "licensesExtrabot"
            | "messenger"
            | "filebankPath"
            | "parentArticle"
            | "quarantine"
            | "quizFieldDefinitions"
            | "quizResponseRecord"
            | "recurringEventRecord"
            | "socialEventRecord"
            | "surveyDateRecord"
            | "bookmark"
        )[];
        signal?: AbortSignal;
    },
): Promise<
    ApiWrapper<
        {
            categories: SearchCategoryValue[];
            count: number;
            facets: SearchFacetValueModel[];
            results: jObjectLittle[];
            start: number;
        },
        BaseMessages,
    >,
>
Return a page of results based on a text query and various filters. All parameters are optional
Parameters
- query: SearchQuery
  - Optionalcategory?: string
  - OptionalfacetCategories?: boolean
  - Optionalfacets?: SearchFacetModel[]
  - Optionalfilters?: SearchQueryFilterModel[]
  - Optionalformat?: FormatList
  - Optionalkeywords?: string
  - Optionallimit?: number
  - Optionaloptions?: SearchQueryOption
  - Optionalpage?: number
  - Optionalsort?: SearchQuerySortModel
- Optionalparams: {
      formatExtension?: (
          | "comments"
          | "search"
          | "actions"
          | "attachments"
          | "contact"
          | "filebank"
          | "licenses"
          | "licensesExtrabot"
          | "messenger"
          | "filebankPath"
          | "parentArticle"
          | "quarantine"
          | "quizFieldDefinitions"
          | "quizResponseRecord"
          | "recurringEventRecord"
          | "socialEventRecord"
          | "surveyDateRecord"
          | "bookmark"
      )[];
      signal?: AbortSignal;
  }
Returns Promise<
    ApiWrapper<
        {
            categories: SearchCategoryValue[];
            count: number;
            facets: SearchFacetValueModel[];
            results: jObjectLittle[];
            start: number;
        },
        BaseMessages,
    >,
>
Search Query Filter Model
@SearchQueryFilterModel.

Search Query Sort Model
default score then date

Abort Signal
to cancel the fetch

// Todo add query.facets (to be specified first)
- Defined in jamespot-user-api/src/apis/search/search.ts:51

setAdminConfig

setAdminConfig(config: any): Promise<ApiWrapper<any, BaseMessages>>
set the platform search-config to the given json object
Parameters
- config: any
  object. json search config
Returns Promise<ApiWrapper<any, BaseMessages>>
- Defined in jamespot-user-api/src/apis/search/search.ts:96

Class JSearchApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns JSearchApi

Properties

jApi

network

Methods

getAdminConfig

Returns Promise<ApiWrapper<any, BaseMessages>>

getConfig

Returns Promise<ApiWrapper<SearchConfig, BaseMessages>>

getLastQueries

Returns Promise<ApiWrapper<SearchLastQuery[], BaseMessages>>

proposition

Parameters

Returns Promise<ApiWrapper<SearchResultCatProps[], BaseMessages>>

Abort Signal

searchQuery

Parameters

Optionalcategory?: string

OptionalfacetCategories?: boolean

Optionalfacets?: SearchFacetModel[]

Optionalfilters?: SearchQueryFilterModel[]

Optionalformat?: FormatList

Optionalkeywords?: string

Optionallimit?: number

Optionaloptions?: SearchQueryOption

Optionalpage?: number

Optionalsort?: SearchQuerySortModel

Returns Promise< ApiWrapper< { categories: SearchCategoryValue[]; count: number; facets: SearchFacetValueModel[]; results: jObjectLittle[]; start: number; }, BaseMessages, >,>

Search Query Filter Model

Search Query Sort Model

Abort Signal

setAdminConfig

Parameters

Returns Promise<ApiWrapper<any, BaseMessages>>

Settings

On This Page

`Optional`category?: string

`Optional`facetCategories?: boolean

`Optional`facets?: SearchFacetModel[]

`Optional`filters?: SearchQueryFilterModel[]

`Optional`format?: FormatList

`Optional`keywords?: string

`Optional`limit?: number

`Optional`options?: SearchQueryOption

`Optional`page?: number

`Optional`sort?: SearchQuerySortModel

Returns Promise<
ApiWrapper<
{
categories: SearchCategoryValue[];
count: number;
facets: SearchFacetValueModel[];
results: jObjectLittle[];
start: number;
},
BaseMessages,
>,
>