@itwin/imodels-client-management/lib/esm/operations/lock/LockOperations.d.ts

iModels API client wrapper for applications that manage iModels.

import { OperationsBase } from "../../base/internal";
import { EntityListIterator, Lock, ReleaseLocksChunkResult } from "../../base/types";
import { OperationOptions } from "../OperationOptions";
import { GetLockListParams, ReleaseLocksChunkParams } 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>;
    /**
     * Releases Locks chunk for a specific Briefcase. This operation is used to release or abandon existing Locks.
     * Wraps the {@link https://developer.bentley.com/apis/imodels-v2/operations/release-imodel-locks-chunk/
     * Release iModel Locks Chunk} operation from iModels API.
     * @param {ReleaseLocksChunkParams} params parameters for this operation. See {@link ReleaseLocksChunkParams}.
     * @returns {Promise<ReleaseLocksChunkResult>} result indicating if this was the last chunk. See {@link ReleaseLocksChunkResult}.
     */
    releaseLocksChunk(params: ReleaseLocksChunkParams): Promise<ReleaseLocksChunkResult>;
}
//# sourceMappingURL=LockOperations.d.ts.map