@itwin/imodels-client-management
Version:
iModels API client wrapper for applications that manage iModels.
44 lines • 3.13 kB
TypeScript
import { OperationsBase } from "../../base/internal";
import { AuthorizationCallback, Changeset, EntityListIterator, HeaderFactories, MinimalChangeset } from "../../base/types";
import { IModelsClient } from "../../IModelsClient";
import { OperationOptions } from "../OperationOptions";
import { GetChangesetListParams, GetSingleChangesetParams } from "./ChangesetOperationParams";
export declare class ChangesetOperations<TOptions extends OperationOptions> extends OperationsBase<TOptions> {
private _iModelsClient;
constructor(options: TOptions, _iModelsClient: IModelsClient);
/**
* Gets Changesets for a specific iModel. This method returns Changesets in their minimal representation. The
* returned iterator internally queries entities in pages. Wraps the
* {@link https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changesets/ Get iModel Changesets}
* operation from iModels API.
* @param {GetChangesetListParams} params parameters for this operation. See {@link GetChangesetListParams}.
* @returns {EntityListIterator<MinimalChangeset>} iterator for Changeset list. See {@link EntityListIterator},
* {@link MinimalChangeset}.
*/
getMinimalList(params: GetChangesetListParams): EntityListIterator<MinimalChangeset>;
/**
* Gets Changesets for a specific iModel. This method returns Changesets 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-changesets/ Get iModel Changesets}
* operation from iModels API.
* @param {GetChangesetListParams} params parameters for this operation. See {@link GetChangesetListParams}.
* @returns {EntityListIterator<Changeset>} iterator for Changeset list. See {@link EntityListIterator},
* {@link Changeset}.
*/
getRepresentationList(params: GetChangesetListParams): EntityListIterator<Changeset>;
/**
* Gets a single Changeset identified by either index or id. This method returns a Changeset in its full representation.
* Wraps the
* {@link https://developer.bentley.com/apis/imodels-v2/operations/get-imodel-changeset-details/ Get iModel Changeset}
* operation from iModels API.
* @param {GetSingleChangesetParams} params parameters for this operation. See {@link GetSingleChangesetParams}.
* @returns {Promise<Changeset>} a Changeset with specified id or index. See {@link Changeset}.
*/
getSingle(params: GetSingleChangesetParams): Promise<Changeset>;
protected querySingleInternal(params: GetSingleChangesetParams): Promise<Changeset>;
protected appendRelatedMinimalEntityCallbacks<TChangeset extends MinimalChangeset>(authorization: AuthorizationCallback, changeset: TChangeset, headers?: HeaderFactories): TChangeset;
protected appendRelatedEntityCallbacks(authorization: AuthorizationCallback, changeset: Changeset, headers?: HeaderFactories): Changeset;
private getNamedVersion;
private getCurrentOrPrecedingCheckpoint;
}
//# sourceMappingURL=ChangesetOperations.d.ts.map