@itwin/core-backend
Version:
iTwin.js backend components
51 lines • 5.34 kB
TypeScript
/** @packageDocumentation
* @module RpcInterface
*/
import { CompressedId64Set, GuidString, Id64String } from "@itwin/core-bentley";
import { CodeProps, CustomViewState3dCreatorOptions, CustomViewState3dProps, DbBlobRequest, DbBlobResponse, DbQueryRequest, DbQueryResponse, ElementLoadOptions, ElementMeshRequestProps, ElementProps, EntityQueryParams, FontMapProps, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, GeometrySummaryRequestProps, HydrateViewStateRequestProps, HydrateViewStateResponseProps, IModelConnectionProps, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelReadRpcInterface, IModelRpcOpenProps, IModelRpcProps, MassPropertiesPerCandidateRequestProps, MassPropertiesPerCandidateResponseProps, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelExtentsProps, ModelProps, RpcInterface, SnapRequestProps, SnapResponseProps, SubCategoryResultRow, TextureData, TextureLoadProps, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
import { Range3dProps } from "@itwin/core-geometry";
/** The backend implementation of IModelReadRpcInterface.
* @internal
*/
export declare class IModelReadRpcImpl extends RpcInterface implements IModelReadRpcInterface {
static register(): void;
getConnectionProps(tokenProps: IModelRpcOpenProps): Promise<IModelConnectionProps>;
getCustomViewState3dData(tokenProps: IModelRpcProps, options: CustomViewState3dCreatorOptions): Promise<CustomViewState3dProps>;
hydrateViewState(tokenProps: IModelRpcProps, options: HydrateViewStateRequestProps): Promise<HydrateViewStateResponseProps>;
queryAllUsedSpatialSubCategories(tokenProps: IModelRpcProps): Promise<SubCategoryResultRow[]>;
querySubCategories(tokenProps: IModelRpcProps, compressedCategoryIds: CompressedId64Set): Promise<SubCategoryResultRow[]>;
queryRows(tokenProps: IModelRpcProps, request: DbQueryRequest): Promise<DbQueryResponse>;
queryBlob(tokenProps: IModelRpcProps, request: DbBlobRequest): Promise<DbBlobResponse>;
queryModelRanges(tokenProps: IModelRpcProps, modelIds: Id64String[]): Promise<Range3dProps[]>;
queryModelExtents(tokenProps: IModelRpcProps, modelIds: Id64String[]): Promise<ModelExtentsProps[]>;
getModelProps(tokenProps: IModelRpcProps, modelIdsList: Id64String[]): Promise<ModelProps[]>;
queryModelProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ModelProps[]>;
getElementProps(tokenProps: IModelRpcProps, elementIdsList: Id64String[]): Promise<ElementProps[]>;
loadElementProps(tokenProps: IModelRpcProps, identifier: Id64String | GuidString | CodeProps, options?: ElementLoadOptions): Promise<ElementProps | undefined>;
getGeometrySummary(tokenProps: IModelRpcProps, request: GeometrySummaryRequestProps): Promise<string>;
queryElementProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ElementProps[]>;
queryEntityIds(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<Id64String[]>;
getClassHierarchy(tokenProps: IModelRpcProps, classFullName: string): Promise<string[]>;
getAllCodeSpecs(tokenProps: IModelRpcProps): Promise<any[]>;
getViewStateData(tokenProps: IModelRpcProps, viewDefinitionId: string, options?: ViewStateLoadProps): Promise<ViewStateProps>;
readFontJson(tokenProps: IModelRpcProps): Promise<FontMapProps>;
requestSnap(tokenProps: IModelRpcProps, sessionId: string, props: SnapRequestProps): Promise<SnapResponseProps>;
cancelSnap(tokenProps: IModelRpcProps, sessionId: string): Promise<void>;
getGeometryContainment(tokenProps: IModelRpcProps, props: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps>;
getMassProperties(tokenProps: IModelRpcProps, props: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps>;
getMassPropertiesPerCandidate(tokenProps: IModelRpcProps, props: MassPropertiesPerCandidateRequestProps): Promise<MassPropertiesPerCandidateResponseProps[]>;
getToolTipMessage(tokenProps: IModelRpcProps, id: string): Promise<string[]>;
/** Send a view thumbnail to the frontend. This is a binary transfer with the metadata in a 16-byte prefix header.
* @deprecated in 3.6.0 - might be removed in next major version. Use queryViewThumbnail instead
*/
getViewThumbnail(tokenProps: IModelRpcProps, viewId: string): Promise<Uint8Array>;
getDefaultViewId(tokenProps: IModelRpcProps): Promise<Id64String>;
getSpatialCategoryId(tokenProps: IModelRpcProps, categoryName: string): Promise<Id64String | undefined>;
getIModelCoordinatesFromGeoCoordinates(tokenProps: IModelRpcProps, props: IModelCoordinatesRequestProps): Promise<IModelCoordinatesResponseProps>;
getGeoCoordinatesFromIModelCoordinates(tokenProps: IModelRpcProps, props: GeoCoordinatesRequestProps): Promise<GeoCoordinatesResponseProps>;
queryTextureData(tokenProps: IModelRpcProps, textureLoadProps: TextureLoadProps): Promise<TextureData | undefined>;
generateElementMeshes(tokenProps: IModelRpcProps, props: ElementMeshRequestProps): Promise<Uint8Array>;
/** @internal */
callViewStore(tokenProps: IModelRpcProps, version: string, forWrite: boolean, methodName: string, ...args: any[]): Promise<any>;
}
//# sourceMappingURL=IModelReadRpcImpl.d.ts.map