TESSA Web API
    Preparing search index...

    Interface ISearchQueryRepository

    Предоставляет доступ к поисковым запросам доступным в системе.

    interface ISearchQueryRepository {
        isInitialized: boolean;
        clearCache(): Promise<void>;
        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>;
        initialize(
            searchQueries: readonly ISearchQueryMetadata[],
            searchQueriesErrors: readonly ISearchQueryMetadataErrorInfo[],
        ): Promise<void>;
        save(metadata: ISearchQueryMetadata): Promise<void>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    isInitialized

    Methods

    clearCache delete getById getPublic getUserAvailable import initialize save

    Properties

    isInitialized: boolean

    Флаг, указывающий на то, что объект был успешно инициализирован.

    Methods

    • Очищает внутренний кеш хранилища.

      Returns Promise<void>

    • Осуществляет удаление поискового запроса.

      Parameters

      • queries: readonly string[]

        Идентификаторы удаляемых поисковых запросов.

      Returns Promise<void>

    • Возвращает поисковый запрос по его идентификатору или null, если запрос не найден или не доступен пользователю.

      Parameters

      • id: string

        Идентификатор поискового запроса.

      Returns Promise<null | ISearchQueryMetadata>

    • Осуществляет импорт поисковых запросов.

      Parameters

      • searchQueries: readonly ISearchQueryMetadata[]

        Список импортируемых поисковых запросов.

      Returns Promise<void>

    • Инициализирует репозиторий поисковых запросов.

      Parameters

      • searchQueries: readonly ISearchQueryMetadata[]

        Метаданные доступных поисковых запросов.

      • searchQueriesErrors: readonly ISearchQueryMetadataErrorInfo[]

        Метаданные поисковых запросов с ошибками.

      Returns Promise<void>

    • Осуществляет сохранение поискового запроса метаданные поискового запроса.

      Parameters

      • metadata: ISearchQueryMetadata

        Метаданные, сохраняемого поискового запроса.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods