close Method

Close this iModel, if it is currently open.

close(requestContext: AuthorizedClientRequestContext, keepBriefcase: KeepBriefcase = KeepBriefcase.Yes): Promise<void>

throws IModelError if the iModel is not open, or is really a snapshot iModel

note Keep the briefcase for as long as required, and if there's a possibility it can be reused. This is especially useful in pull and push workflows where keeping the briefcase will allow reusing the same briefcase id.

Parameter Type Description
requestContext AuthorizedClientRequestContext The client request context.
keepBriefcase KeepBriefcase Hint to discard or keep the briefcase for potential future use.

Defined in

Last Updated: 08 January, 2020