File

projects/netgrif-components-core/src/lib/search/category-factory/optional-dependencies.ts

Description

Other dependencies that the CategoryFactory provides to the Categories it creates. The Categories don't have to use any of them.

Index

Properties

Properties

allowedNetsService
allowedNetsService: AllowedNetsService
Type : AllowedNetsService
categoryFactory
categoryFactory: CategoryFactory
Type : CategoryFactory

Reference to the Factory itself. Useful if your choices in one category require a query from a different category as well. Most commonly used to get an instance of CaseProcess Category to limit queries on identifiers that are only unique within a net to that net.

ignoreNetsOnAutocompleteCategories
ignoreNetsOnAutocompleteCategories: boolean
Type : boolean
Optional

When set to true, autocomplete categories will ignore net filtering. This can be useful when you want autocomplete suggestions to include results from all nets, regardless of the currently selected net context.

searchIndexResolver
searchIndexResolver: SearchIndexResolverService
Type : SearchIndexResolverService
userResourceService
userResourceService: UserResourceService | null
Type : UserResourceService | null

If the CategoryFactory cannot inject an instance of this service into itself null will be provided.

import {CategoryFactory} from './category-factory';
import {UserResourceService} from '../../resources/engine-endpoint/user-resource.service';
import {SearchIndexResolverService} from '../search-keyword-resolver-service/search-index-resolver.service';
import {AllowedNetsService} from '../../allowed-nets/services/allowed-nets.service';

/**
 * Other dependencies that the {@link CategoryFactory} provides to the [Categories]{@link Category} it creates.
 * The Categories don't have to use any of them.
 */
export interface OptionalDependencies {
    /**
     * Reference to the Factory itself. Useful if your choices in one category require a query from a different category as well.
     * Most commonly used to get an instance of {@link CaseProcess} Category to limit queries on identifiers that are only unique
     * within a net to that net.
     */
    categoryFactory: CategoryFactory;
    searchIndexResolver: SearchIndexResolverService;
    allowedNetsService: AllowedNetsService;
    /**
     * If the {@link CategoryFactory} cannot inject an instance of this service into itself `null` will be provided.
     */
    userResourceService: UserResourceService | null;
    /**
     * When set to `true`, autocomplete categories will ignore net filtering.
     * This can be useful when you want autocomplete suggestions to include results from all nets,
     * regardless of the currently selected net context.
     */
    ignoreNetsOnAutocompleteCategories?: boolean;
}

results matching ""

    No results matching ""