Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PlatformSdkClient

Hierarchy

  • PlatformSdkClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • client: MendixSdkClient
    • username: string
    • apikey: string | undefined
    • projectsApiEndpoint: string

    Returns PlatformSdkClient

Properties

Private _apikey

_apikey: string | undefined

Private _client

_client: MendixSdkClient

Private _projectsApiEndpoint

_projectsApiEndpoint: string

Private _username

_username: string

Private _xmlParser

_xmlParser: Parser

Static Private HTTP_STATUS_OK_RESPONSE_CODE

HTTP_STATUS_OK_RESPONSE_CODE: number = 200

Static Private HTTP_STATUS_WS_ERROR_RESPONSE_CODE

HTTP_STATUS_WS_ERROR_RESPONSE_CODE: number = 500

Static Private PROJECTS_API_PATH

PROJECTS_API_PATH: string = "/ws/ProjectsAPI/11/soap1"

Static Private commitWorkingCopyChangesXml

commitWorkingCopyChangesXml: string = PlatformSdkClient._templatePath("CommitWorkingCopyChanges.xml")

Static Private createNewAppXml

createNewAppXml: string = PlatformSdkClient._templatePath("CreateNewApp.xml")

Static Private createOnlineWorkingCopyXml

createOnlineWorkingCopyXml: string = PlatformSdkClient._templatePath("CreateOnlineWorkingCopy.xml")

Static Private deleteAppXml

deleteAppXml: string = PlatformSdkClient._templatePath("DeleteApp.xml")

Static Private retrieveJobStatusXml

retrieveJobStatusXml: string = PlatformSdkClient._templatePath("RetrieveJobStatus.xml")

Methods

Private _awaitJobResult

  • _awaitJobResult(jobId: string): Promise<JobResult>

  • Parameters

    • jobId: string

    Returns Promise<JobResult>

Private _compilePayload

  • _compilePayload(templateName: string, data: object): string

  • Parameters

    • templateName: string
    • data: object

    Returns string

Private _createHttpErrorCodeInterceptor

  • _createHttpErrorCodeInterceptor(errorMessage: string): Interceptor<__type>

  • Parameters

    • errorMessage: string

    Returns Interceptor<__type>

Private _createRequestContent

  • _createRequestContent(templateText: string, data: object): RequestContents

  • Parameters

    • templateText: string
    • data: object

    Returns RequestContents

Private _parseAndQuery

  • _parseAndQuery(xml: string, query: string): Promise<string>

  • Parameters

    • xml: string
    • query: string

    Returns Promise<string>

Private _parseJobResult

  • Parameters

    • parsed: object

    Returns JobResult

Private _parseJobStatus

  • _parseJobStatus(): Interceptor<__type>

  • Returns Interceptor<__type>

Private _parseResult

  • _parseResult(): Interceptor<__type>

  • Returns Interceptor<__type>

commitToTeamServer

  • Commit changes in your Online Working Copy to your model back to the Team Server.

    Parameters

    • workingCopy: OnlineWorkingCopy

      an OnlineWorkingCopy instance pointing to a working copy on the Mendix Model server.

    • Default value branchName: string | null = null

      (Optional) The name of the branch to commit to, or null for main line. Default is null.

    • Default value baseRevision: number = -1

      (Optional) The base revision for this commit, or -1 for HEAD. Default is -1.

    Returns Promise<Revision>

    a Promise of a Team Server Revision corresponding to the given workingCopy.

createNewApp

  • createNewApp(projectName: string, projectSummary?: undefined | string, templateUUID?: undefined | string): Promise<Project>

  • Creates a new app and commits it to the Team Server.

    Parameters

    • projectName: string

      The name of the new app

    • Optional projectSummary: undefined | string

      (Optional) A short description of the new app

    • Optional templateUUID: undefined | string

    Returns Promise<Project>

    a Promise of a Mendix App Project

createOnlineWorkingCopy

  • Expose a specific Team Server revision as an Online Working Copy.

    Parameters

    • project: Project

      an instance of a Mendix App Project

    • Optional revision: Revision

      A Revision instance pointing to a revision number on a specific Team Server branch

    Returns Promise<OnlineWorkingCopy>

    a Promise of an OnlineWorkingCopy in the Mendix Model Server corresponding to the given project and revision.

deleteApp

  • deleteApp(appId: string): Promise<void>

  • Deletes an application, including all resources that are associated with it, like the Team Server repository, cloud nodes, and all model server working copies. The operation can only be called by someone who has administrative permissions on the project (usually the user that created the project).

    Parameters

    • appId: string

      The App ID of the app in the Platform Portal.

    Returns Promise<void>

    a Promise of void

Static Private _templatePath

  • _templatePath(filename: string): string

  • Parameters

    • filename: string

    Returns string

Generated using TypeDoc