Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModelSdkClientImpl<IT, CT>

Client class of the Mendix Model SDK. By instantiating this class with appropriate configuration, you can create and read working copies.

Type parameters

Hierarchy

  • ModelSdkClientImpl

Index

Constructors

constructor

Methods

checkAccess

  • checkAccess(workingCopyId: string, memberOpenId: string, callback: ICallback<boolean>, errorCallback: IErrorCallback): void
  • checkAccess(workingCopyId: string, memberOpenId: string): Promise
  • Returns whether the member specified to his/her OpenID has (been granted) access to this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise

commitToTeamServer

createAndOpenWorkingCopy

createWorkingCopy

createWorkingCopyFromTeamServer

deleteWorkingCopy

  • deleteWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • deleteWorkingCopy(workingCopyId: string): Promise
  • Deletes this working copy from the server, and the (SDK) client.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise

deleteWorkingCopyByProject

  • deleteWorkingCopyByProject(projectId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • deleteWorkingCopyByProject(projectId: string): Promise
  • Deletes the project-to-working copy mapping for given project ID.

    Parameters

    Returns void

  • Parameters

    • projectId: string

    Returns Promise

exportModuleMpk

  • exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • exportModuleMpk(workingCopyId: string, moduleId: string, outFilePath: string): Promise
  • Exports the module with the specified ID as MPK.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • moduleId: string
    • outFilePath: string

    Returns Promise

exportMpk

  • exportMpk(workingCopyId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • exportMpk(workingCopyId: string, outFilePath: string): Promise
  • Exports this working copy as MPK.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • outFilePath: string

    Returns Promise

getAppEnvironmentStatus

getAppEnvironmentStatusV2

getAppUpdateStatus

  • getAppUpdateStatus(workingCopyId: string, jobId: string, callback: ICallback<IDeployJobStatus>, errorCallback: IErrorCallback): void
  • getAppUpdateStatus(workingCopyId: string, jobId: string): Promise
  • Start deploy this working copy and create new job.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • jobId: string

    Returns Promise

getMyWorkingCopies

getWorkingCopyByProject

  • getWorkingCopyByProject(projectId: string, callback: ICallback<string>, errorCallback: IErrorCallback): void
  • getWorkingCopyByProject(projectId: string): Promise
  • Retrieves the working copy id that the given project ID maps to.

    Parameters

    Returns void

  • Parameters

    • projectId: string

    Returns Promise

grantAccess

  • grantAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • grantAccess(workingCopyId: string, memberOpenId: string): Promise
  • Grants access to the member specified to his/her OpenID on this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise

grantAccessByProject

  • grantAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • grantAccessByProject(projectId: string, memberOpenId: string): Promise
  • Grants access to the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • memberOpenId: string

    Returns Promise

loadWorkingCopyMetaData

  • loadWorkingCopyMetaData(workingCopyId: string, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void
  • loadWorkingCopyMetaData(workingCopyId: string): Promise
  • Gets meta data of a working copy

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise

lockWorkingCopy

openWorkingCopy

  • openWorkingCopy(workingCopyId: string, callback: ICallback<IT>, errorCallback: IErrorCallback): void
  • openWorkingCopy(workingCopyId: string): Promise
  • Reads a working copy on the model server so it can be edited.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise

revokeAccess

  • revokeAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • revokeAccess(workingCopyId: string, memberOpenId: string): Promise
  • Revokes access of the member specified to his/her OpenID on this working copy.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • memberOpenId: string

    Returns Promise

revokeAccessByProject

  • revokeAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • revokeAccessByProject(projectId: string, memberOpenId: string): Promise
  • Revokes access of the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • memberOpenId: string

    Returns Promise

startAppUpdate

  • Start deploy this working copy and create new job.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise

unlockWorkingCopy

  • Unlock the working copy (will be unlocked for the currently authenticated openid, will fail if it's locked by another openid).

    Provide a lockType to only unlock the working copy if it is locked with this specific type.

    Parameters

    Returns void

  • Parameters

    • workingCopyId: string

    Returns Promise

  • Parameters

    Returns void

  • Parameters

    • workingCopyId: string
    • lockType: LockType

    Returns Promise

updateWorkingCopyByProject

  • updateWorkingCopyByProject(projectId: string, workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
  • updateWorkingCopyByProject(projectId: string, workingCopyId: string): Promise
  • Update the project-to-working copy mapping with the given data.

    Parameters

    Returns void

  • Parameters

    • projectId: string
    • workingCopyId: string

    Returns Promise

Generated using TypeDoc