Options
All
  • Public
  • Public/Protected
  • All
Menu

Class App

The object API of the Mendix app.

Hierarchy

  • App

Index

Constructors

Properties

Methods

Constructors

constructor

  • new App(appId: string): App

  • Parameters

    • appId: string

    Returns App

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.

Methods

createTemporaryWorkingCopy

  • Create a temporary working copy by giving the branch name and optionally some options. The working copy will be based on what is in the given branch of the model repository and stored online.

    Parameters

    • branchName: string

      The branch name to base the working copy on.

      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.

    • Optional options: ICreateTemporaryWorkingCopyOptions

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

    Returns Promise<OnlineWorkingCopy>

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

delete

  • delete(): Promise<void>

  • Delete the current app.

    Note: be careful when using this, since this is permanent and will remove all data of this app.

    Returns Promise<void>

getOnlineWorkingCopy

  • Open an existing working copy by giving its ID.

    Parameters

    • workingCopyId: string

      The ID of the working copy to open.

    Returns OnlineWorkingCopy

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

getRepository

  • Get Repository object, including model repository info.

    Returns Repository

    the object API of the model repository, which can be used to call the Public Team Server API.

Generated using TypeDoc