@itwin/imodels-client-management/lib/cjs/operations/lock/LockOperationParams.d.ts

iModels API client wrapper for applications that manage iModels.

import { CollectionRequestParams, IModelScopedOperationParams, LockLevel } from "../../base/types";
/** Valid values for Lock filtering by their level. */
export type LockLevelFilter = LockLevel.Shared | LockLevel.Exclusive;
/** Url parameters supported in Lock list query. */
export interface GetLockListUrlParams extends CollectionRequestParams {
    /** Filters Locks by a specific Briefcase. */
    briefcaseId?: number;
    /** Filters Locks by their level. See {@link LockLevelFilter}. */
    lockLevel?: LockLevelFilter;
}
/** Parameters for get Lock list operation. */
export interface GetLockListParams extends IModelScopedOperationParams {
    /** Parameters that will be appended to the entity list request url that will narrow down the results. */
    urlParams?: GetLockListUrlParams;
}
/** Parameters for release Locks chunk operation. */
export interface ReleaseLocksChunkParams extends IModelScopedOperationParams {
    /** Id of the Briefcase to release Locks for. */
    briefcaseId: number;
    /**
     * Id of the latest Changeset in which the locked object was updated. If this value points to an older Changeset than
     * the value saved on the server, the server value will not be updated. It means the lock was abandoned.
     */
    changesetId?: string;
}
//# sourceMappingURL=LockOperationParams.d.ts.map