Skip to main content

Query

The QueryService is responsible for handling search queries, including fetching and displaying search results.

Functions

search(q?: Partial<Query>, includeQueryParams?: boolean, audit?: AuditEvents): Observable<Result>
NameTypeDescription
qPartial<Query>(Optional) The partial query object.
includeQueryParamsboolean(Optional) Indicates whether to include query parameters automatically.
auditAuditEvents(Optional) The audit events object.

Returns

Observable<Result> - An observable that emits the search results.

Usage

import { inject } from "@angular/core";
import { QueryService } from "@sinequa/atomic-angular";

const queryService = inject(QueryService);
queryService.search({ text: 'example' }).subscribe(results => {
console.log(results);
});

bulkSearch()

bulkSearch(q: Query[], audit?: AuditEvents): Observable<Result[]>
NameTypeDescription
qQuery[]An array of Query objects representing the search queries.
auditAuditEvents(Optional) An object for auditing purposes.

Returns

Observable<Result[]> - An observable that emits an array of Result objects.

Usage

import { inject } from "@angular/core";
import { QueryService } from "@sinequa/atomic-angular";

const queryService = inject(QueryService);
queryService.bulkSearch([{ text: 'example1' }, { text: 'example2' }]).subscribe(results => {
console.log(results);
});

gotoPage()

Navigates to the specified page and returns the search result.

gotoPage(page: number): void
ParameterTypeDescription
pagenumberThe page number to navigate to.

Usage Example:

import { inject } from "@angular/core";
import { QueryService } from "@sinequa/atomic-angular";

const queryService = inject(QueryService);
queryService.gotoPage(2);

This method updates the page number in the query parameters store and audit information about the page navigation.