pushChanges Method
pushChanges(description)
Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.
pushChanges(description: string): Promise<ChangesetIndexAndId>
@returns the changesetId of the pushed changes
@note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset uploaded.
@see onChangesPushed for the event dispatched after changes are pushed.
| Parameter | Type | Description |
|---|---|---|
| description | string | The description for the changeset |
Returns - Promise<ChangesetIndexAndId>
the changesetId of the pushed changes
pushChanges(description, options?) @beta
Create a changeset from local Txns and push to iModelHub. On success, clear Txn table.
pushChanges(description: string, options?: PushChangesOptions): Promise<ChangesetIndexAndId>
@returns the changesetId of the pushed changes
@note Any changes made by other users are first pulled, applied, and merged with the local Txns. Only then is the resulting changeset uploaded.
@see onChangesPushed for the event dispatched after changes are pushed.
| Parameter | Type | Description |
|---|---|---|
| description | string | The description for the changeset |
| options | PushChangesOptions | Options reporting the progress of - and optionally cancelling - the download of the changes that are pulled before pushing. |
Returns - Promise<ChangesetIndexAndId>
the changesetId of the pushed changes
Defined in
Last Updated: 24 September, 2026