UNPKG

@itwin/clash-detection-client

Version:

Clash Detection client for the iTwin platform

43 lines 3.08 kB
import { OperationsBase } from "../../base/OperationsBase"; import type { ResponseFromGetModelsAndCategories, ResponseFromGetSchemaInfo } from "../../base/interfaces/apiEntities/IModelInterfaces"; import type { OperationOptions } from "../OperationOptions"; import type { ParamsToExtractModelsAndCategories, ParamsToExtractSchemaInfo, ParamsToGetModelsAndCategories, ParamsToGetSchemaInfo } from "./IModelOperationParams"; export declare class IModelOperations<TOptions extends OperationOptions> extends OperationsBase<TOptions> { constructor(options: TOptions); /** * Gets schema info identified by project and iModel id. * Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/get-schema-info/ * Get schema info} operation from Clash Detection API. * @param {ParamsToGetSchemaInfo} params parameters for this operation. See {@link ParamsToGetSchemaInfo}. * @returns {Promise<ResponseFromGetSchemaInfo>} schema info for specified iModel and project id. See {@link ResponseFromGetSchemaInfo}. * @deprecated The method should not be used */ getSchemaInfo(params: ParamsToGetSchemaInfo): Promise<ResponseFromGetSchemaInfo>; /** * Extracts schema info. Required once per iModel before calling getSchemaInfo(). Extraction is only performed if needed. * Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/extract-schema-info/ * Extract schema info} operation from Clash Detection API. * @param {ParamsToExtractSchemaInfo} params parameters for this operation. See {@link ParamsToExtractSchemaInfo}. * @returns {Promise<void>}. * @deprecated The method should not be used */ extractSchemaInfo(params: ParamsToExtractSchemaInfo): Promise<void>; /** * Gets models and categories identified by project and iModel id. * Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/get-models-and-categories/ * Get models and categories} operation from Clash Detection API. * @param {ParamsToGetModelsAndCategories} params parameters for this operation. See {@link ParamsToGetModelsAndCategories}. * @returns {Promise<ModelsAndCategories>} models and categories for specified iModel and project id. See {@link ModelsAndCategories}. * @deprecated The method should not be used */ getModelsAndCategories(params: ParamsToGetModelsAndCategories): Promise<ResponseFromGetModelsAndCategories>; /** * Extracts models and categories. Wraps the {@link https://developer.bentley.com/apis/clash-detection/operations/extract-models-and-categories/ * Extract models and categories} operation from Clash Detection API. * @param {ParamsToExtractModelsAndCategories} params parameters for this operation. See {@link ParamsToExtractModelsAndCategories}. * @returns {Promise<void>}. * @deprecated The method should not be used */ extractModelsAndCategories(params: ParamsToExtractModelsAndCategories): Promise<void>; } //# sourceMappingURL=IModelOperations.d.ts.map