@itwin/imodels-client-authoring
Version:
iModels API client wrapper for applications that author iModels.
25 lines • 1.59 kB
TypeScript
import { EntityListIterator, OperationsBase } from "@itwin/imodels-client-management";
import { Lock } from "../../base/types";
import { OperationOptions } from "../OperationOptions";
import { GetLockListParams, UpdateLockParams } from "./LockOperationParams";
export declare class LockOperations<TOptions extends OperationOptions> extends OperationsBase<TOptions> {
/**
* Gets Locks for a specific iModel. This method returns Locks in their full representation. The returned iterator
* internally queries entities in pages. Wraps the
* {@link https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-locks/ Get iModel Locks} operation from
* iModels API.
* @param {GetLockListParams} params parameters for this operation. See {@link GetLockListParams}.
* @returns {EntityListIterator<Lock>} iterator for Lock list. See {@link EntityListIterator}, {@link Lock}.
*/
getList(params: GetLockListParams): EntityListIterator<Lock>;
/**
* Updates Lock for a specific Briefcase. This operation is used to acquire new locks and change the lock level for
* already existing ones. Wraps the {@link https://developer.bentley.com/apis/imodels-v2/operations/update-imodel-locks/
* Update iModel Locks} operation from iModels API.
* @param {UpdateLockParams} params parameters for this operation. See {@link UpdateLockParams}.
* @returns {Promise<Lock>} updated Lock. See {@link Lock}.
*/
update(params: UpdateLockParams): Promise<Lock>;
private getUpdateLockBody;
}
//# sourceMappingURL=LockOperations.d.ts.map