@itwin/property-validation-client
Version:
Property Validation client for the iTwin platform
25 lines • 1.78 kB
TypeScript
import { OperationsBase } from "../../base/OperationsBase";
import type { ResponseFromGetPropertiesInfo } from "../../base/interfaces/apiEntities/PropertiesInfoInterfaces";
import type { OperationOptions } from "../OperationOptions";
import type { ParamsToExtractSchemaInfo, ParamsToGetPropertiesInfo } from "./SchemaOperationParams";
export declare class SchemaOperations<TOptions extends OperationOptions> extends OperationsBase<TOptions> {
constructor(options: TOptions);
/**
* Extracts schema/properties info. Required once per iModel before calling getPropertiesInfo().
* 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} parameters for this operation. See {@link ParamsToExtractSchemaInfo}.
* @returns {Promise<void>}.
* @deprecated The method should not be used
*/
extractSchemaInfo(params: ParamsToExtractSchemaInfo): Promise<void>;
/**
* Gets properties info identified by project and iModel id.
* Wraps the {@link https://developer.bentley.com/apis/validation/operations/get-validation-propertyvalue-properties/
* Get properties info} operation from Property Validation API.
* @param {ParamsToGetPropertiesInfo} params parameters for this operation. See {@link ParamsToGetPropertiesInfo}.
* @returns {Promise<ResponseFromGetPropertiesInfo>} status and properties info for the specified iModel and filter string. See {@link ResponseFromGetPropertiesInfo}.
*/
getPropertiesInfo(params: ParamsToGetPropertiesInfo): Promise<ResponseFromGetPropertiesInfo>;
}
//# sourceMappingURL=SchemaOperations.d.ts.map