Interface ISearchQueryService

Сервис сохраненных поисковых запросов.

interface ISearchQueryService {
    delete(queries: readonly string[]): Promise<void>;
    getById(id: string): Promise<null | ISearchQueryMetadata>;
    getPublic(): Promise<
        [ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]],
    >;
    getUserAvailable(): Promise<
        [ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]],
    >;
    import(searchQueries: readonly ISearchQueryMetadata[]): Promise<void>;
    save(metadata: ISearchQueryMetadata): Promise<void>;
}

Hierarchy (View Summary)

ISearchQueryService
- ISearchQueryRepository

Implemented by

SearchQueryService

Index

Methods

delete getById getPublic getUserAvailable import save

Methods

delete

delete(queries: readonly string[]): Promise<void>
Осуществляет удаление поискового запроса.
Parameters
- queries: readonly string[]
  Идентификаторы удаляемых поисковых запросов.
Returns Promise<void>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:52

getById

getById(id: string): Promise<null | ISearchQueryMetadata>
Возвращает поисковый запрос по его идентификатору или null, если запрос не найден или не доступен пользователю.
Parameters
- id: string
  Идентификатор поискового запроса.
Returns Promise<null | ISearchQueryMetadata>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:58

getPublic

getPublic(): Promise<[ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]]>
Возвращает метаданные только общедоступных поисковых запросов.

Returns Promise<[ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]]>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:62

getUserAvailable

getUserAvailable(): Promise<
[ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]],
>
Возвращает список доступных пользователю поисковых запросов.

Returns Promise<[ISearchQueryMetadata[], ISearchQueryMetadataErrorInfo[]]>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:66

import

import(searchQueries: readonly ISearchQueryMetadata[]): Promise<void>
Осуществляет импорт поисковых запросов.
Parameters
- searchQueries: readonly ISearchQueryMetadata[]
  Список импортируемых поисковых запросов.
Returns Promise<void>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:71

save

save(metadata: ISearchQueryMetadata): Promise<void>
Осуществляет сохранение поискового запроса метаданные поискового запроса.
Parameters
- metadata: ISearchQueryMetadata
  Метаданные, сохраняемого поискового запроса.
Returns Promise<void>
- Defined in @tessa/platform/src/views/searchQueries/searchQueryTypes.ts:76