Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OnlineWorkingCopy

The object API of the online working copy, which can be used to open and edit its contents and to commit made changes.

Hierarchy

  • OnlineWorkingCopy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly appId

appId: string

The App ID used to uniquely identify the Mendix app. The App ID can be found in the Developer Portal under the General Settings page of the app.

Note: the App ID is sometimes also called Project ID.

Readonly workingCopyId

workingCopyId: string

The working copy ID used to uniquely identify the online working copy.

Methods

commitToRepository

  • Commit the changes of the working copy to the model repository.

    Note: make sure to call model.flushChanges() after making changes to the model and before committing with this method. This makes sure that the Model SDK has been able to send the changes to the online working copy.

    Parameters

    • Optional branchName: string

      The branch of the model repository to which the changes are committed.

      The name of the default branch is "trunk" for Subversion repositories and "main" for Git repositories. To specify a non-default branch for a Subversion repository, the branch name must begin with the "branches/" prefix.

      Note: This must be the same branch that the working copy was based on, otherwise an error will be thrown. Set options.force to true to override this check.

    • Optional options: ICommitTemporaryWorkingCopyOptions

      The options to use to commit the working copy such as commit ID and message.

    Returns Promise<void>

openModel

  • openModel(): Promise<IModel>

  • Open the model of the online working copy. This can be used to read and edit the contents of the online working copy of the app.

    Note: the return value of this method is an instance of IModel, which is defined in the Model SDK.

    Returns Promise<IModel>

    The model of the online working copy.

Generated using TypeDoc