Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Repository

The object API of a model repository, which can be used to get info about its branches and commits.

Hierarchy

  • Repository

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.

Methods

getBranch

  • getBranch(branchName: string): Promise<IBranch>

  • Gets information about a specific branch of the version control model repository for a Mendix app.

    Parameters

    • branchName: string

      The name of the branch for which to return information.

      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.

    Returns Promise<IBranch>

    Information about a specific branch of the version control model repository for a Mendix app.

getBranchCommits

  • Gets information about the commits of a specific branch of the version control model repository for a Mendix app. Commits are returned in reverse chronological order, starting from the head of the branch all the way to the first commit of the model repository. The response is paginated using cursor-based pagination.

    Parameters

    • branchName: string

      The name of the branch for which to return information.

      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: IGetBranchCommitsOptions

      Query parameters.

    Returns Promise<ICommits>

    Information about the commits of a specific branch of the version control model repository for a Mendix app.

getBranches

  • Gets information about the branches of the version control model repository for a Mendix app. The response is paginated using cursor-based pagination.

    Parameters

    Returns Promise<IBranches>

    Information about the branches of the version control model repository for a Mendix app.

getInfo

  • Get generic information about the model repository.

    Returns Promise<IRepositoryInfo>

    Generic information about the model repository.

Generated using TypeDoc