@itwin/core-common 3.4.6 → 3.4.7

package/lib/esm/IpcAppProps.d.ts

@@ -1,125 +1,125 @@
-/** @packageDocumentation
- * @module NativeApp
- */
-import { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from "@itwin/core-bentley";
-import { Range3dProps, XYZProps } from "@itwin/core-geometry";
-import { OpenBriefcaseProps } from "./BriefcaseTypes";
-import { ChangedEntities } from "./ChangedEntities";
-import { ChangesetIndex, ChangesetIndexAndId } from "./ChangesetProps";
-import { GeographicCRSProps } from "./geometry/CoordinateReferenceSystem";
-import { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, StandaloneOpenOptions } from "./IModel";
-import { ModelGeometryChangesProps } from "./ModelGeometryChanges";
-/** 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 enum IpcAppChannel {
-    Functions = "ipc-app",
-    AppNotify = "ipcApp-notify",
-    Txns = "txns",
-    EditingScope = "editing-scope"
-}
-/**
- * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.
- * @internal
- */
-export interface IpcAppNotifications {
-    notifyApp: () => void;
-}
-/** 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: ChangedEntities) => void;
-    notifyModelsChanged: (changes: ChangedEntities) => void;
-    notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;
-    notifyCommit: () => void;
-    notifyCommitted: (hasPendingTxns: boolean, time: number) => 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 */
-    openStandalone: (_filePath: string, _openMode: OpenMode, _opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;
-    /** see BriefcaseConnection.close */
-    closeIModel: (key: string) => Promise<void>;
-    /** see BriefcaseConnection.saveChanges */
-    saveChanges: (key: string, description?: 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) => Promise<ChangesetIndexAndId>;
-    /** 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>;
-}
+/** @packageDocumentation
+ * @module NativeApp
+ */
+import { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from "@itwin/core-bentley";
+import { Range3dProps, XYZProps } from "@itwin/core-geometry";
+import { OpenBriefcaseProps } from "./BriefcaseTypes";
+import { ChangedEntities } from "./ChangedEntities";
+import { ChangesetIndex, ChangesetIndexAndId } from "./ChangesetProps";
+import { GeographicCRSProps } from "./geometry/CoordinateReferenceSystem";
+import { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, StandaloneOpenOptions } from "./IModel";
+import { ModelGeometryChangesProps } from "./ModelGeometryChanges";
+/** 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 enum IpcAppChannel {
+    Functions = "ipc-app",
+    AppNotify = "ipcApp-notify",
+    Txns = "txns",
+    EditingScope = "editing-scope"
+}
+/**
+ * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.
+ * @internal
+ */
+export interface IpcAppNotifications {
+    notifyApp: () => void;
+}
+/** 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: ChangedEntities) => void;
+    notifyModelsChanged: (changes: ChangedEntities) => void;
+    notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;
+    notifyCommit: () => void;
+    notifyCommitted: (hasPendingTxns: boolean, time: number) => 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 */
+    openStandalone: (_filePath: string, _openMode: OpenMode, _opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;
+    /** see BriefcaseConnection.close */
+    closeIModel: (key: string) => Promise<void>;
+    /** see BriefcaseConnection.saveChanges */
+    saveChanges: (key: string, description?: 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) => Promise<ChangesetIndexAndId>;
+    /** 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

package/lib/esm/IpcAppProps.js

@@ -1,16 +1,16 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module NativeApp
- */
-/** @internal */
-export var IpcAppChannel;
-(function (IpcAppChannel) {
-    IpcAppChannel["Functions"] = "ipc-app";
-    IpcAppChannel["AppNotify"] = "ipcApp-notify";
-    IpcAppChannel["Txns"] = "txns";
-    IpcAppChannel["EditingScope"] = "editing-scope";
-})(IpcAppChannel || (IpcAppChannel = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module NativeApp
+ */
+/** @internal */
+export var IpcAppChannel;
+(function (IpcAppChannel) {
+    IpcAppChannel["Functions"] = "ipc-app";
+    IpcAppChannel["AppNotify"] = "ipcApp-notify";
+    IpcAppChannel["Txns"] = "txns";
+    IpcAppChannel["EditingScope"] = "editing-scope";
+})(IpcAppChannel || (IpcAppChannel = {}));
 //# sourceMappingURL=IpcAppProps.js.map

package/lib/esm/IpcAppProps.js.map

@@ -1 +1 @@
-{"version":3,"file":"IpcAppProps.js","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAiCH,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;IAC3B,8BAAa,CAAA;IACb,+CAA8B,CAAA;AAChC,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module NativeApp\r\n */\r\n\r\nimport { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from \"@itwin/core-bentley\";\r\nimport { Range3dProps, XYZProps } from \"@itwin/core-geometry\";\r\nimport { OpenBriefcaseProps } from \"./BriefcaseTypes\";\r\nimport { ChangedEntities } from \"./ChangedEntities\";\r\nimport { ChangesetIndex, ChangesetIndexAndId } from \"./ChangesetProps\";\r\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\r\nimport { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, StandaloneOpenOptions } from \"./IModel\";\r\nimport { ModelGeometryChangesProps } from \"./ModelGeometryChanges\";\r\n\r\n/** Identifies a list of tile content Ids belonging to a single tile tree.\r\n * @internal\r\n */\r\nexport interface TileTreeContentIds {\r\n  treeId: string;\r\n  contentIds: string[];\r\n}\r\n\r\n/** Specifies a [GeometricModel]($backend)'s Id and a Guid identifying the current state of the geometry contained within the model.\r\n * @see [TxnManager.onModelGeometryChanged]($backend) and [BriefcaseTxns.onModelGeometryChanged]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ModelIdAndGeometryGuid {\r\n  /** The model's Id. */\r\n  id: Id64String;\r\n  /** 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.\r\n   * This is primarily an implementation detail used to determine whether [Tile]($frontend)s produced for one revision are compatible with another revision.\r\n   */\r\n  guid: GuidString;\r\n}\r\n\r\n/** @internal */\r\nexport enum IpcAppChannel {\r\n  Functions = \"ipc-app\",\r\n  AppNotify = \"ipcApp-notify\",\r\n  Txns = \"txns\",\r\n  EditingScope = \"editing-scope\",\r\n}\r\n\r\n/**\r\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.\r\n * @internal\r\n */\r\nexport interface IpcAppNotifications {\r\n  notifyApp: () => void;\r\n}\r\n\r\n/** Interface implemented by the frontend [NotificationHandler]($common) to be notified of changes to an iModel.\r\n * @see [TxnManager]($backend) for the source of these events.\r\n * @see [BriefcaseTxns]($frontend) for the frontend implementation.\r\n * @internal\r\n */\r\nexport interface TxnNotifications {\r\n  notifyElementsChanged: (changes: ChangedEntities) => void;\r\n  notifyModelsChanged: (changes: ChangedEntities) => void;\r\n  notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;\r\n  notifyCommit: () => void;\r\n  notifyCommitted: (hasPendingTxns: boolean, time: number) => void;\r\n  notifyChangesApplied: () => void;\r\n  notifyBeforeUndoRedo: (isUndo: boolean) => void;\r\n  notifyAfterUndoRedo: (isUndo: boolean) => void;\r\n  notifyPulledChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\r\n  notifyPushedChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\r\n\r\n  notifyIModelNameChanged: (name: string) => void;\r\n  notifyRootSubjectChanged: (subject: RootSubjectProps) => void;\r\n  notifyProjectExtentsChanged: (extents: Range3dProps) => void;\r\n  notifyGlobalOriginChanged: (origin: XYZProps) => void;\r\n  notifyEcefLocationChanged: (ecef: EcefLocationProps | undefined) => void;\r\n  notifyGeographicCoordinateSystemChanged: (gcs: GeographicCRSProps | undefined) => void;\r\n}\r\n\r\n/**\r\n * Interface registered by the frontend [NotificationHandler]($common) to be notified of changes to an iModel during an [GraphicalEditingScope]($frontend).\r\n * @internal\r\n */\r\nexport interface EditingScopeNotifications {\r\n  notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;\r\n}\r\n\r\n/**\r\n * The methods that may be invoked via Ipc from the frontend of an IpcApp and are implemented on its backend.\r\n * @internal\r\n */\r\nexport interface IpcAppFunctions {\r\n  /** Send frontend log to backend.\r\n   * @param _level Specify log level.\r\n   * @param _category Specify log category.\r\n   * @param _message Specify log message.\r\n   * @param _metaData metaData if any.\r\n   */\r\n  log: (_timestamp: number, _level: LogLevel, _category: string, _message: string, _metaData?: any) => Promise<void>;\r\n\r\n  /** see BriefcaseConnection.openFile */\r\n  openBriefcase: (_args: OpenBriefcaseProps) => Promise<IModelConnectionProps>;\r\n  /** see BriefcaseConnection.openStandalone */\r\n  openStandalone: (_filePath: string, _openMode: OpenMode, _opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;\r\n  /** see BriefcaseConnection.close */\r\n  closeIModel: (key: string) => Promise<void>;\r\n  /** see BriefcaseConnection.saveChanges */\r\n  saveChanges: (key: string, description?: string) => Promise<void>;\r\n  /** see BriefcaseTxns.hasPendingTxns */\r\n  hasPendingTxns: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.isUndoPossible */\r\n  isUndoPossible: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.isRedoPossible */\r\n  isRedoPossible: (key: string) => Promise<boolean>;\r\n  /** see BriefcaseTxns.getUndoString */\r\n  getUndoString: (key: string) => Promise<string>;\r\n  /** see BriefcaseTxns.getRedoString */\r\n  getRedoString: (key: string) => Promise<string>;\r\n\r\n  /** see BriefcaseConnection.pullChanges */\r\n  pullChanges: (key: string, toIndex?: ChangesetIndex) => Promise<ChangesetIndexAndId>;\r\n  /** see BriefcaseConnection.pushChanges */\r\n  pushChanges: (key: string, description: string) => Promise<ChangesetIndexAndId>;\r\n  /** Cancels currently pending or active generation of tile content.  */\r\n  cancelTileContentRequests: (tokenProps: IModelRpcProps, _contentIds: TileTreeContentIds[]) => Promise<void>;\r\n\r\n  /** Cancel element graphics requests.\r\n   * @see [[IModelTileRpcInterface.requestElementGraphics]].\r\n   */\r\n  cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;\r\n\r\n  toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;\r\n  isGraphicalEditingSupported: (key: string) => Promise<boolean>;\r\n\r\n  reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;\r\n  reverseAllTxn: (key: string) => Promise<IModelStatus>;\r\n  reinstateTxn: (key: string) => Promise<IModelStatus>;\r\n  restartTxnSession: (key: string) => Promise<void>;\r\n\r\n  /** Query the number of concurrent threads supported by the host's IO or CPU thread pool. */\r\n  queryConcurrency: (pool: \"io\" | \"cpu\") => Promise<number>;\r\n}\r\n\r\n"]}
+{"version":3,"file":"IpcAppProps.js","sourceRoot":"","sources":["../../src/IpcAppProps.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAiCH,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,sCAAqB,CAAA;IACrB,4CAA2B,CAAA;IAC3B,8BAAa,CAAA;IACb,+CAA8B,CAAA;AAChC,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module NativeApp\n */\n\nimport { GuidString, Id64String, IModelStatus, LogLevel, OpenMode } from \"@itwin/core-bentley\";\nimport { Range3dProps, XYZProps } from \"@itwin/core-geometry\";\nimport { OpenBriefcaseProps } from \"./BriefcaseTypes\";\nimport { ChangedEntities } from \"./ChangedEntities\";\nimport { ChangesetIndex, ChangesetIndexAndId } from \"./ChangesetProps\";\nimport { GeographicCRSProps } from \"./geometry/CoordinateReferenceSystem\";\nimport { EcefLocationProps, IModelConnectionProps, IModelRpcProps, RootSubjectProps, StandaloneOpenOptions } from \"./IModel\";\nimport { ModelGeometryChangesProps } from \"./ModelGeometryChanges\";\n\n/** Identifies a list of tile content Ids belonging to a single tile tree.\n * @internal\n */\nexport interface TileTreeContentIds {\n  treeId: string;\n  contentIds: string[];\n}\n\n/** Specifies a [GeometricModel]($backend)'s Id and a Guid identifying the current state of the geometry contained within the model.\n * @see [TxnManager.onModelGeometryChanged]($backend) and [BriefcaseTxns.onModelGeometryChanged]($frontend).\n * @public\n * @extensions\n */\nexport interface ModelIdAndGeometryGuid {\n  /** The model's Id. */\n  id: Id64String;\n  /** 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.\n   * This is primarily an implementation detail used to determine whether [Tile]($frontend)s produced for one revision are compatible with another revision.\n   */\n  guid: GuidString;\n}\n\n/** @internal */\nexport enum IpcAppChannel {\n  Functions = \"ipc-app\",\n  AppNotify = \"ipcApp-notify\",\n  Txns = \"txns\",\n  EditingScope = \"editing-scope\",\n}\n\n/**\n * Interface implemented by the frontend [NotificationHandler]($common) to be notified of events from IpcApp backend.\n * @internal\n */\nexport interface IpcAppNotifications {\n  notifyApp: () => void;\n}\n\n/** Interface implemented by the frontend [NotificationHandler]($common) to be notified of changes to an iModel.\n * @see [TxnManager]($backend) for the source of these events.\n * @see [BriefcaseTxns]($frontend) for the frontend implementation.\n * @internal\n */\nexport interface TxnNotifications {\n  notifyElementsChanged: (changes: ChangedEntities) => void;\n  notifyModelsChanged: (changes: ChangedEntities) => void;\n  notifyGeometryGuidsChanged: (changes: ModelIdAndGeometryGuid[]) => void;\n  notifyCommit: () => void;\n  notifyCommitted: (hasPendingTxns: boolean, time: number) => void;\n  notifyChangesApplied: () => void;\n  notifyBeforeUndoRedo: (isUndo: boolean) => void;\n  notifyAfterUndoRedo: (isUndo: boolean) => void;\n  notifyPulledChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\n  notifyPushedChanges: (parentChangeSetId: ChangesetIndexAndId) => void;\n\n  notifyIModelNameChanged: (name: string) => void;\n  notifyRootSubjectChanged: (subject: RootSubjectProps) => void;\n  notifyProjectExtentsChanged: (extents: Range3dProps) => void;\n  notifyGlobalOriginChanged: (origin: XYZProps) => void;\n  notifyEcefLocationChanged: (ecef: EcefLocationProps | undefined) => void;\n  notifyGeographicCoordinateSystemChanged: (gcs: GeographicCRSProps | undefined) => void;\n}\n\n/**\n * Interface registered by the frontend [NotificationHandler]($common) to be notified of changes to an iModel during an [GraphicalEditingScope]($frontend).\n * @internal\n */\nexport interface EditingScopeNotifications {\n  notifyGeometryChanged: (modelProps: ModelGeometryChangesProps[]) => void;\n}\n\n/**\n * The methods that may be invoked via Ipc from the frontend of an IpcApp and are implemented on its backend.\n * @internal\n */\nexport interface IpcAppFunctions {\n  /** Send frontend log to backend.\n   * @param _level Specify log level.\n   * @param _category Specify log category.\n   * @param _message Specify log message.\n   * @param _metaData metaData if any.\n   */\n  log: (_timestamp: number, _level: LogLevel, _category: string, _message: string, _metaData?: any) => Promise<void>;\n\n  /** see BriefcaseConnection.openFile */\n  openBriefcase: (_args: OpenBriefcaseProps) => Promise<IModelConnectionProps>;\n  /** see BriefcaseConnection.openStandalone */\n  openStandalone: (_filePath: string, _openMode: OpenMode, _opts?: StandaloneOpenOptions) => Promise<IModelConnectionProps>;\n  /** see BriefcaseConnection.close */\n  closeIModel: (key: string) => Promise<void>;\n  /** see BriefcaseConnection.saveChanges */\n  saveChanges: (key: string, description?: string) => Promise<void>;\n  /** see BriefcaseTxns.hasPendingTxns */\n  hasPendingTxns: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.isUndoPossible */\n  isUndoPossible: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.isRedoPossible */\n  isRedoPossible: (key: string) => Promise<boolean>;\n  /** see BriefcaseTxns.getUndoString */\n  getUndoString: (key: string) => Promise<string>;\n  /** see BriefcaseTxns.getRedoString */\n  getRedoString: (key: string) => Promise<string>;\n\n  /** see BriefcaseConnection.pullChanges */\n  pullChanges: (key: string, toIndex?: ChangesetIndex) => Promise<ChangesetIndexAndId>;\n  /** see BriefcaseConnection.pushChanges */\n  pushChanges: (key: string, description: string) => Promise<ChangesetIndexAndId>;\n  /** Cancels currently pending or active generation of tile content.  */\n  cancelTileContentRequests: (tokenProps: IModelRpcProps, _contentIds: TileTreeContentIds[]) => Promise<void>;\n\n  /** Cancel element graphics requests.\n   * @see [[IModelTileRpcInterface.requestElementGraphics]].\n   */\n  cancelElementGraphicsRequests: (key: string, _requestIds: string[]) => Promise<void>;\n\n  toggleGraphicalEditingScope: (key: string, _startSession: boolean) => Promise<boolean>;\n  isGraphicalEditingSupported: (key: string) => Promise<boolean>;\n\n  reverseTxns: (key: string, numOperations: number) => Promise<IModelStatus>;\n  reverseAllTxn: (key: string) => Promise<IModelStatus>;\n  reinstateTxn: (key: string) => Promise<IModelStatus>;\n  restartTxnSession: (key: string) => Promise<void>;\n\n  /** Query the number of concurrent threads supported by the host's IO or CPU thread pool. */\n  queryConcurrency: (pool: \"io\" | \"cpu\") => Promise<number>;\n}\n\n"]}