Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update several tags in common and frontend @beta to public #1068

Merged
merged 9 commits into from
Mar 31, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion common/api/imodeljs-backend.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4080,7 +4080,7 @@ export enum SqliteValueType {
String = 3
}

// @internal
// @public
export class StandaloneDb extends IModelDb {
get changeSetId(): undefined;
static createEmpty(filePath: string, args: CreateEmptyStandaloneIModelProps): StandaloneDb;
Expand Down
2 changes: 1 addition & 1 deletion common/api/summary/imodeljs-backend.exports.csv
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ internal;SqliteStatement
internal;SqliteStatementCache
internal;SqliteValue
internal;SqliteValueType
internal;StandaloneDb
public;StandaloneDb
internal;StringParam
public;SubCategory
public;Subject
Expand Down
12 changes: 6 additions & 6 deletions core/backend/src/IModelDb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2639,10 +2639,11 @@ export class SnapshotDb extends IModelDb {
}

/** Standalone iModels are read/write files that are not managed by iModelHub.
* They are relevant only for single-practitioner scenarios where team collaboration is necessary.
* However, Standalone iModels are designed such that the API interaction between Standalone iModels and Briefcase
* They are relevant only for small-scale single-user scenarios.
* Standalone iModels are designed such that the API for Standalone iModels and Briefcase
* iModels (those synchronized with iModelHub) are as similar and consistent as possible.
* This leads to a straightforward process where the practitioner can optionally choose to upgrade to iModelHub.
* This leads to a straightforward process where the a user starts with StandaloneDb and can
* optionally choose to upgrade to iModelHub.
*
* Some additional details. Standalone iModels:
* - always have [Guid.empty]($bentley) for their contextId (they are "unassociated" files)
Expand All @@ -2651,9 +2652,8 @@ export class SnapshotDb extends IModelDb {
* - may be opened without supplying any user credentials
* - may be opened read/write
* - may optionally support undo/redo via [[TxmManager]]
* - cannot apply a changeset to nor generate a changesets
* - are only available to authorized applications
* @internal
* - cannot apply a changeset to nor generate a changesets (since there is no timeline from which to get/push changesets)
* @public
pmconne marked this conversation as resolved.
Show resolved Hide resolved
*/
export class StandaloneDb extends IModelDb {
public get isStandalone(): boolean { return true; }
Expand Down
2 changes: 1 addition & 1 deletion core/common/src/IModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export interface SnapshotOpenOptions extends IModelEncryptionProps, OpenDbKey {
autoUploadBlocks?: boolean;
}

/** Options supplied to open an existing StandaloneDb.
/** Options supplied to open a StandaloneDb.
pmconne marked this conversation as resolved.
Show resolved Hide resolved
* @public
*/
export type StandaloneOpenOptions = OpenDbKey;
Expand Down