download Method

Method to download the seed file for iModel. This will download the original seed file, that was uploaded when creating iModel. To download a file that was updated with ChangeSets on iModelHub, see BriefcaseHandler.download.

download(requestContext: AuthorizedClientRequestContext, contextId: string, path: string, progressCallback?: (progress: ProgressInfo) => void): Promise<void>

throws IModelHubError with [IModelHubStatus.iModelDoesNotExist]$(bentley) if iModel does not exist.

throws Common iModelHub errors

Parameter Type Description
requestContext AuthorizedClientRequestContext The client request context.
contextId string Id for the iModel's context. For iModelHub it should be the id of the connect context (IModelHandler.Project or IModelHandler.Asset).
path string Path where seed file should be downloaded, including filename.
progressCallback (progress: ProgressInfo) => void Callback for tracking progress.

Defined in

Last Updated: 08 January, 2020