@itwin/core-common/lib/esm/IpcAppProps.d.ts

iTwin.js components common to frontend and backend

/** @packageDocumentation
 * @module NativeApp
 */
import { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from "@itwin/core-bentley";
import { Range3dProps, XYZProps } from "@itwin/core-geometry";
import { OpenBriefcaseProps, OpenCheckpointArgs } from "./BriefcaseTypes";
import { ChangedEntities } from "./ChangedEntities";
import { ChangesetIndex, ChangesetIndexAndId } from "./ChangesetProps";
import { GeographicCRSProps } from "./geometry/CoordinateReferenceSystem";
import { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, SnapshotOpenOptions, StandaloneOpenOptions } from "./IModel";
import { ModelGeometryChangesProps } from "./ModelGeometryChanges";
/** Options for pulling changes into iModel.
 * @internal
 */
export interface PullChangesOptions {
    /** Enables progress reporting. */
    reportProgress?: boolean;
    /** Interval for reporting progress (in milliseconds). */
    progressInterval?: number;
    /** Enables checks for abort. */
    enableCancellation?: boolean;
}
/** Get IPC channel name used for reporting progress of pulling changes into iModel.
 * @internal
 */
export declare const getPullChangesIpcChannel: (iModelId: string) => string;
/** Identifies a list of tile content Ids belonging to a single tile tree.
 * @internal
 */
export interface TileTreeContentIds {
    treeId: string;
    contentIds: string[];
}
/** Specifies a [GeometricModel]($backend)'s Id and a Guid identifying the current state of the geometry contained within the model.
 * @see [TxnManager.onModelGeometryChanged]($backend) and [BriefcaseTxns.onModelGeometryChanged]($frontend).
 * @public
 * @extensions
 */
export interface ModelIdAndGeometryGuid {
    /** The model's Id. */
    id: Id64String;
    /** A unique identifier for the current state of the model's geometry. If the guid differs between two revisions of the same iModel, it indicates that the geometry differs.
     * This is primarily an implementation detail used to determine whether [Tile]($frontend)s produced for one revision are compatible with another revision.
     */
    guid: GuidString;
}
/** @internal */
export declare const ipcAppChannels: {
    readonly functions: "itwinjs-core/ipc-app";
    readonly appNotify: "itwinjs-core/ipcApp-notify";
    readonly txns: "itwinjs-core/txns";
    readonly editingScope: "itwinjs-core/editing-scope";
};
/**
 * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.
 * @internal
 */
export interface IpcAppNotifications {
    notifyApp: () => void;
}
/** @internal */
export interface NotifyEntitiesChangedMetadata {
    /** Class full name ("Schema:Class") */
    name: string;
    /** The indices in [[NotifyEntitiesChangedArgs.meta]] of each of this class's **direct** base classes. */
    bases: number[];
}
/** Arguments supplied to [[TxnNotifications.notifyElementsChanged]] and [[TxnNotifications.notifyModelsChanged]].
 * @internal
 */
export interface NotifyEntitiesChangedArgs extends ChangedEntities {
    /** An array of the same length as [[ChangedEntities.inserted]] (or empty if that array is undefined), containing the index in the [[meta]] array at which the
     * metadata for each entity's class is located.
     */
    insertedMeta: number[];
    /** See insertedMeta. */
    updatedMeta: number[];
    /** See insertedMeta. */
    deletedMeta: number[];
    /** Metadata describing each unique class of entity in this set of changes, followed by each unique direct or indirect base class of those classes. */
    meta: NotifyEntitiesChangedMetadata[];
}
/** Interface implemented by the frontend [NotificationHandler]($common) to be notified of changes to an iModel.
 * @see [TxnManager]($backend) for the source of these events.
 * @see [BriefcaseTxns]($frontend) for the frontend implementation.
 * @internal
 */
export interface TxnNotifications {
    notifyElementsChanged: (changes: NotifyEntitiesChangedArgs) => void;
    notifyModelsChanged: (changes: NotifyEntitiesChangedArgs) => void;
    notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;
    notifyCommit: () => void;
    notifyCommitted: (hasPendingTxns: boolean, time: number) => void;
    notifyReplayExternalTxns: () => void;
    notifyReplayedExternalTxns: () => void;
    notifyChangesApplied: () => void;
    notifyBeforeUndoRedo: (isUndo: boolean) => void;
    notifyAfterUndoRedo: (isUndo: boolean) => void;
    notifyPulledChanges: (parentChangeSetId: ChangesetIndexAndId) => void;
    notifyPushedChanges: (parentChangeSetId: ChangesetIndexAndId) => void;
    notifyIModelNameChanged: (name: string) => void;
    notifyRootSubjectChanged: (subject: RootSubjectProps) => void;
    notifyProjectExtentsChanged: (extents: Range3dProps) => void;
    notifyGlobalOriginChanged: (origin: XYZProps) => void;
    notifyEcefLocationChanged: (ecef: EcefLocationProps | undefined) => void;
    notifyGeographicCoordinateSystemChanged: (gcs: GeographicCRSProps | undefined) => void;
}
/**
 * Interface registered by the frontend [NotificationHandler]($common) to be notified of changes to an iModel during an [GraphicalEditingScope]($frontend).
 * @internal
 */
export interface EditingScopeNotifications {
    notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;
}
/**
 * The methods that may be invoked via Ipc from the frontend of an IpcApp and are implemented on its backend.
 * @internal
 */
export interface IpcAppFunctions {
    /** Send frontend log to backend.
     * @param _level Specify log level.
     * @param _category Specify log category.
     * @param _message Specify log message.
     * @param _metaData metaData if any.
     */
    log: (_timestamp: number, _level: LogLevel, _category: string, _message: string, _metaData?: any) => Promise<void>;
    /** see BriefcaseConnection.openFile */
    openBriefcase: (args: OpenBriefcaseProps) => Promise<IModelConnectionProps>;
    /** see BriefcaseConnection.openStandalone */
    openCheckpoint: (args: OpenCheckpointArgs) => Promise<IModelConnectionProps>;
    /** see BriefcaseConnection.openStandalone */
    openStandalone: (filePath: string, openMode: OpenMode, opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;
    /** see SnapshotConnection.openFile */
    openSnapshot: (filePath: string, opts?: SnapshotOpenOptions) => Promise<IModelConnectionProps>;
    /** see BriefcaseConnection.close */
    closeIModel: (key: string) => Promise<void>;
    /** see BriefcaseConnection.saveChanges */
    saveChanges: (key: string, description?: string) => Promise<void>;
    /** see BriefcaseConnection.abandonChanges */
    abandonChanges: (key: string) => Promise<void>;
    /** see BriefcaseTxns.hasPendingTxns */
    hasPendingTxns: (key: string) => Promise<boolean>;
    /** see BriefcaseTxns.isUndoPossible */
    isUndoPossible: (key: string) => Promise<boolean>;
    /** see BriefcaseTxns.isRedoPossible */
    isRedoPossible: (key: string) => Promise<boolean>;
    /** see BriefcaseTxns.getUndoString */
    getUndoString: (key: string) => Promise<string>;
    /** see BriefcaseTxns.getRedoString */
    getRedoString: (key: string) => Promise<string>;
    /** see BriefcaseConnection.pullChanges */
    pullChanges: (key: string, toIndex?: ChangesetIndex, options?: PullChangesOptions) => Promise<ChangesetIndexAndId>;
    /** Cancels pull of changes. */
    cancelPullChangesRequest: (key: string) => Promise<void>;
    /** see BriefcaseConnection.pushChanges */
    pushChanges: (key: string, description: string) => Promise<ChangesetIndexAndId>;
    /** Cancels currently pending or active generation of tile content.  */
    cancelTileContentRequests: (tokenProps: IModelRpcProps, _contentIds: TileTreeContentIds[]) => Promise<void>;
    /** Cancel element graphics requests.
     * @see [[IModelTileRpcInterface.requestElementGraphics]].
     */
    cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;
    toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;
    isGraphicalEditingSupported: (key: string) => Promise<boolean>;
    reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;
    reverseAllTxn: (key: string) => Promise<IModelStatus>;
    reinstateTxn: (key: string) => Promise<IModelStatus>;
    restartTxnSession: (key: string) => Promise<void>;
    /** Query the number of concurrent threads supported by the host's IO or CPU thread pool. */
    queryConcurrency: (pool: "io" | "cpu") => Promise<number>;
}
//# sourceMappingURL=IpcAppProps.d.ts.map