@sitecore/sc-contenthub-webclient-sdk/dist/contracts/querying/entity-load-option.d.ts

Sitecore Content Hub WebClient SDK.

import type { Nullable } from "../../base-types";
import CultureInfo from "../../culture-info";
import { IQueryLoadConfiguration } from "./query-load-configuration";
/**
 * Specifies if and how resulting entities should be loaded.
 */
export declare class EntityLoadOption {
    /**
     * Indicates if entities should be loaded.
     */
    loadEntities: boolean;
    /**
     * The names of the properties to load with the entities.
     * If the value contains "*", all properties will be loaded.
     * If the value is null, no properties will be loaded.
     *
     * The default value is ["*"], which means all properties will be loaded.
     */
    propertiesToLoad: Nullable<Array<string>>;
    /**
     * The names of the relations to load with the entities.
     * If the value is null, no relations will be loaded.
     *
     * The default value is null, which mean no relations will be loaded.
     */
    relationsToLoad: Nullable<Array<string>>;
    /**
     * The cultures to load the entities in.
     * If not specified, the entities will only be loaded in the invariant-culture.
     *
     * If the collection contains value "*", the entities will be loaded in all installed cultures.
     */
    culturesToLoad?: Array<CultureInfo | "*">;
    toQueryLoadConfiguration(): IQueryLoadConfiguration;
}