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

Properties

Methods

Constructors

constructor

Properties

Private client

client: any

Private connectionConfig

connectionConfig: any

Private modelConstructor

modelConstructor: any

Methods

checkAccess

  • checkAccess(workingCopyId: string, memberOpenId: string, callback: ICallback<boolean>, errorCallback: IErrorCallback): void

  • Returns whether the member specified to his/her OpenID has (been granted) access to this working copy.

    Parameters

    • workingCopyId: string
    • memberOpenId: string
    • callback: ICallback<boolean>
    • errorCallback: IErrorCallback

    Returns void

createWorkingCopy

  • Create a new working copy on the model server, and reads it for immediate editing.

    Parameters

    Returns void

deleteWorkingCopy

  • deleteWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Deletes this working copy from the server, and the (SDK) client.

    Parameters

    • workingCopyId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

deleteWorkingCopyByProject

  • deleteWorkingCopyByProject(projectId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Deletes the project-to-working copy mapping for given project ID.

    Parameters

    • projectId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

deploy

  • deploy(workingCopyId: string, forceFullDeployment: boolean, callback: ICallback<IDeploymentResult>, errorCallback: IErrorCallback): void

  • Deploy this working copy.

    Parameters

    • workingCopyId: string
    • forceFullDeployment: boolean
    • callback: ICallback<IDeploymentResult>
    • errorCallback: IErrorCallback

    Returns void

exportMpk

  • exportMpk(workingCopyId: string, outFilePath: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Exports this working copy as MPK.

    Parameters

    • workingCopyId: string
    • outFilePath: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

getDeploymentStatus

  • getDeploymentStatus(workingCopyId: string, callback: ICallback<IDeploymentResult>, errorCallback: IErrorCallback): void

  • Retrieves status information about the working copy deployment.

    Parameters

    • workingCopyId: string
    • callback: ICallback<IDeploymentResult>
    • errorCallback: IErrorCallback

    Returns void

getEditorData

  • getEditorData(callback: ICallback<IEditorData>, errorCallback: IErrorCallback): void

  • Retrieves an array of UUIDs for helper working copies for each supported Mendix version.

    These are pre-defined working copies that are accessible for read operations, and contain units that might come in handy when creating pages from templates.

    Parameters

    • callback: ICallback<IEditorData>
    • errorCallback: IErrorCallback

    Returns void

getMyWorkingCopies

  • getMyWorkingCopies(callback: ICallback<IWorkingCopy[]>, errorCallback: IErrorCallback): void

  • Retrieves an array of all working copies you are a member of.

    Parameters

    • callback: ICallback<IWorkingCopy[]>
    • errorCallback: IErrorCallback

    Returns void

getWorkingCopyByProject

  • getWorkingCopyByProject(projectId: string, callback: ICallback<string>, errorCallback: IErrorCallback): void

  • Retrieves the working copy id that the given project ID maps to.

    Parameters

    • projectId: string
    • callback: ICallback<string>
    • errorCallback: IErrorCallback

    Returns void

grantAccess

  • grantAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Grants access to the member specified to his/her OpenID on this working copy.

    Parameters

    • workingCopyId: string
    • memberOpenId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

grantAccessByProject

  • grantAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Grants access to the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    • projectId: string
    • memberOpenId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

loadWorkingCopyMetaData

  • loadWorkingCopyMetaData(workingCopyId: string, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void

  • Gets meta data of a working copy

    Parameters

    • workingCopyId: string
    • callback: ICallback<IWorkingCopy>
    • errorCallback: IErrorCallback

    Returns void

lockWorkingCopy

  • lockWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Lock the working copy (will be locked for the currently authenticated openid)

    Parameters

    • workingCopyId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

openWorkingCopy

  • openWorkingCopy(workingCopyId: string, callback: ICallback<IT>, errorCallback: IErrorCallback): void

  • Reads a working copy on the model server so it can be edited.

    Parameters

    • workingCopyId: string
    • callback: ICallback<IT>
    • errorCallback: IErrorCallback

    Returns void

revokeAccess

  • revokeAccess(workingCopyId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Revokes access of the member specified to his/her OpenID on this working copy.

    Parameters

    • workingCopyId: string
    • memberOpenId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

revokeAccessByProject

  • revokeAccessByProject(projectId: string, memberOpenId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Revokes access of the member specified to his/her OpenID to the default working copy of this project.

    Parameters

    • projectId: string
    • memberOpenId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

unlockWorkingCopy

  • unlockWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

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

    Parameters

    • workingCopyId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

updateWorkingCopyByProject

  • updateWorkingCopyByProject(projectId: string, workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void

  • Update the project-to-working copy mapping with the given data.

    Parameters

    • projectId: string
    • workingCopyId: string
    • callback: IVoidCallback
    • errorCallback: IErrorCallback

    Returns void

Generated using TypeDoc