Options
All
  • Public
  • Public/Protected
  • All
Menu

API client to create and delete Mendix apps.

Hierarchy

  • AppsClient

Index

Constructors

Methods

  • Create a new Mendix app in the Mendix Platform and commit it in the model repository.

    Parameters

    • appName: string

      Name of the app (maximum 200 characters; must not contain any special characters other than spaces (‘ ’), dash (‘-’) or underscore (‘_’)

    • Optional options: ICreateNewAppOptions

      Options to create the app such as image and app template.

    Returns Promise<string>

    The app ID (also known as project ID) of the created Mendix app.

  • deleteApp(appId: string): Promise<void>
  • Delete an app by giving it's app ID.

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

    Parameters

    • appId: string

      The app ID (also known as project ID) of the Mendix app to delete.

    Returns Promise<void>

Generated using TypeDoc