Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MendixPlatformClient

API client to interact with the Mendix Platform.

Hierarchy

  • MendixPlatformClient

Index

Constructors

Methods

Constructors

constructor

Methods

createNewApp

  • 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<App>

    The object API of the created Mendix app.

getApp

  • getApp(appId: string): App

  • Get the object API of the specified Mendix app.

    Parameters

    • appId: string

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

    Returns App

    The object API of the specified Mendix app.

Generated using TypeDoc