ModelSdkClientImpl | Mendix Model SDK

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

Type parameters

IT: IAbstractModel
CT: AbstractModel & IT

Hierarchy

ModelSdkClientImpl

Constructors

constructor

new ModelSdkClientImpl(connectionConfig: ISdkConfig, modelConstructor: object): ModelSdkClientImpl

Parameters
- connectionConfig: ISdkConfig
- modelConstructor: object
  - constructor: function
    - new __type(_client: IModelServerClient, _errorHandler: IErrorCallback, _connectionConfig: ISdkConfig): __type
    - Parameters
      - _client: IModelServerClient
      - _errorHandler: IErrorCallback
      - _connectionConfig: ISdkConfig
      Returns __type
Returns ModelSdkClientImpl

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
- workingCopyId: string
- memberOpenId: string
- callback: ICallback<boolean>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- memberOpenId: string
Returns Promise

commitToTeamServer

commitToTeamServer(workingCopyId: string, options: ICommitToTeamServerOptions, callback: ICallback<number>, errorCallback: IErrorCallback): void
commitToTeamServer(workingCopyId: string, options: ICommitToTeamServerOptions): Promise

Commits the contents of the working copy with the given id to the team server

Parameters
- workingCopyId: string
- options: ICommitToTeamServerOptions
- callback: ICallback<number>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- options: ICommitToTeamServerOptions
Returns Promise

createAndOpenWorkingCopy

createAndOpenWorkingCopy(workingCopyParameters: ICreateWorkingCopyParameters, callback: ICallback<IT>, errorCallback: IErrorCallback): void
createAndOpenWorkingCopy(workingCopyParameters: ICreateWorkingCopyParameters): Promise

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

Parameters
- workingCopyParameters: ICreateWorkingCopyParameters
- callback: ICallback<IT>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyParameters: ICreateWorkingCopyParameters
Returns Promise

createWorkingCopy

createWorkingCopy(workingCopyParameters: ICreateWorkingCopyParameters, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void
createWorkingCopy(workingCopyParameters: ICreateWorkingCopyParameters): Promise

Create a new working copy on the model server.

Parameters
- workingCopyParameters: ICreateWorkingCopyParameters
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyParameters: ICreateWorkingCopyParameters
Returns Promise

createWorkingCopyFromTeamServer

createWorkingCopyFromTeamServer(workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters, callback: ICallback<IWorkingCopy>, errorCallback: IErrorCallback): void
createWorkingCopyFromTeamServer(workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters): Promise

Create a new working copy on the model server from a team server repository.

Parameters
- workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters
Returns Promise

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
- workingCopyId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- projectId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- workingCopyId: string
- moduleId: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- workingCopyId: string
- outFilePath: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- outFilePath: string
Returns Promise

getAppEnvironmentStatus

getAppEnvironmentStatus(workingCopyId: string, callback: ICallback<IEnvironmentStatus>, errorCallback: IErrorCallback): void
getAppEnvironmentStatus(workingCopyId: string): Promise

Parameters
- workingCopyId: string
- callback: ICallback<IEnvironmentStatus>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
Returns Promise

getAppEnvironmentStatusV2

getAppEnvironmentStatusV2(workingCopyId: string, callback: ICallback<IEnvironmentStatus>, errorCallback: IErrorCallback): void
getAppEnvironmentStatusV2(workingCopyId: string): Promise

Parameters
- workingCopyId: string
- callback: ICallback<IEnvironmentStatus>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
Returns Promise

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
- workingCopyId: string
- jobId: string
- callback: ICallback<IDeployJobStatus>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- jobId: string
Returns Promise

getMyWorkingCopies

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

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

Parameters
- callback: ICallback<IWorkingCopy[]>
- errorCallback: IErrorCallback
Returns void
Returns Promise

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
- projectId: string
- callback: ICallback<string>
- errorCallback: IErrorCallback
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
- workingCopyId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- projectId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- workingCopyId: string
- callback: ICallback<IWorkingCopy>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
Returns Promise

lockWorkingCopy

lockWorkingCopy(workingCopyId: string, callback: ICallback<ILockWorkingCopyResponse>, errorCallback: IErrorCallback): void
lockWorkingCopy(workingCopyId: string, lockOptions: ILockWorkingCopyOptions | LockType, callback: ICallback<ILockWorkingCopyResponse>, errorCallback: IErrorCallback): void
lockWorkingCopy(workingCopyId: string, lockOptions: ILockWorkingCopyOptions | LockType): Promise

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

Parameters
- workingCopyId: string
- callback: ICallback<ILockWorkingCopyResponse>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- lockOptions: ILockWorkingCopyOptions | LockType
- callback: ICallback<ILockWorkingCopyResponse>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
- lockOptions: ILockWorkingCopyOptions | LockType
Returns Promise

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
- workingCopyId: string
- callback: ICallback<IT>
- errorCallback: IErrorCallback
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
- workingCopyId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- projectId: string
- memberOpenId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Parameters
- projectId: string
- memberOpenId: string
Returns Promise

startAppUpdate

startAppUpdate(workingCopyId: string, callback: ICallback<IDeployJobStatus>, errorCallback: IErrorCallback): void
startAppUpdate(workingCopyId: string): Promise

Start deploy this working copy and create new job.

Parameters
- workingCopyId: string
- callback: ICallback<IDeployJobStatus>
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
Returns Promise

unlockWorkingCopy

unlockWorkingCopy(workingCopyId: string, callback: IVoidCallback, errorCallback: IErrorCallback): void
unlockWorkingCopy(workingCopyId: string): Promise
unlockWorkingCopy(workingCopyId: string, lockType: LockType, callback: IVoidCallback, errorCallback: IErrorCallback): void
unlockWorkingCopy(workingCopyId: string, lockType: LockType): Promise

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
- workingCopyId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Parameters
- workingCopyId: string
Returns Promise
Parameters
- workingCopyId: string
- lockType: LockType
- callback: IVoidCallback
- errorCallback: IErrorCallback
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
- projectId: string
- workingCopyId: string
- callback: IVoidCallback
- errorCallback: IErrorCallback
Returns void
Parameters
- projectId: string
- workingCopyId: string
Returns Promise

Type parameters

IT: IAbstractModel

CT: AbstractModel & IT

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

connectionConfig: ISdkConfig

modelConstructor: object

constructor: function

Parameters

_client: IModelServerClient

_errorHandler: IErrorCallback

_connectionConfig: ISdkConfig

Returns __type

Returns ModelSdkClientImpl

Methods

checkAccess

Parameters

workingCopyId: string

memberOpenId: string

callback: ICallback<boolean>

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyId: string

memberOpenId: string

Returns Promise

commitToTeamServer

Parameters

workingCopyId: string

options: ICommitToTeamServerOptions

callback: ICallback<number>

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyId: string

options: ICommitToTeamServerOptions

Returns Promise

createAndOpenWorkingCopy

Parameters

workingCopyParameters: ICreateWorkingCopyParameters

callback: ICallback<IT>

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyParameters: ICreateWorkingCopyParameters

Returns Promise

createWorkingCopy

Parameters

workingCopyParameters: ICreateWorkingCopyParameters

callback: ICallback<IWorkingCopy>

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyParameters: ICreateWorkingCopyParameters

Returns Promise

createWorkingCopyFromTeamServer

Parameters

workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters

callback: ICallback<IWorkingCopy>

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyParameters: ICreateWorkingCopyFromTeamServerParameters

Returns Promise

deleteWorkingCopy

Parameters

workingCopyId: string

callback: IVoidCallback

errorCallback: IErrorCallback

Returns void

Parameters

workingCopyId: string

Returns Promise

deleteWorkingCopyByProject

Parameters